You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are a couple of things that we need to update in the contributing guide:
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 BranchIn order to be considered for merging, the pull request changes mustnot 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 asdescribed 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.
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
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.
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
The text was updated successfully, but these errors were encountered:
Type of feature
📝 Documentation
Current behavior
There are a couple of things that we need to update in the contributing guide:
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:
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.
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
Additional context
No response
Code of Conduct
Contributing Docs
The text was updated successfully, but these errors were encountered: