Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Update "Introduction to Contributing" #287

Closed
2 tasks done
adiati98 opened this issue Mar 28, 2024 · 1 comment · Fixed by #288
Closed
2 tasks done

Feature: Update "Introduction to Contributing" #287

adiati98 opened this issue Mar 28, 2024 · 1 comment · Fixed by #288
Assignees
Labels
📝 documentation 💡 feature A label to note if work is a feature released

Comments

@adiati98
Copy link
Member

Type of feature

📝 Documentation

Current behavior

There are a couple of things that we need to update in the contributing guide:

  1. Create New Branch: Compliance

    We have a compliance action that runs to check protected branch. If changes are made directly on default branch, it will give below message:

    ## Protected Branch
    
    In order to be considered for merging, the pull request changes must
    not be implemented on the "%branch%" branch. This is described in our
    [Contributing Guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/).
    We would suggest that you close this PR and implement your changes as
    described in our Contributing Guide and open a new pull request.

    Contributors are suggested to close the PR and create a new branch as described in the contributing guide. However, we don't have this stated anywhere in our contributing guide.

  2. Admonitions

    Docusaurus supports special admonitions syntax to highlight note, tip, info, etc. There are some notes and tips that we can highlight in this page.

Suggested solution

  1. Update the instructions in Pull Requests section by emphasizing the importance of creating new branch and that PRs that has been made directly on default branch will be closed.
  2. Add special Docusaurus special admonitions syntax for notes and tips accross the page.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@adiati98 adiati98 added 💡 feature A label to note if work is a feature 📝 documentation core team work labels Mar 28, 2024
@adiati98 adiati98 self-assigned this Mar 28, 2024
Copy link
Contributor

github-actions bot commented Apr 4, 2024

🎉 This issue has been resolved in version 1.70.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 documentation 💡 feature A label to note if work is a feature released
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant