-
Notifications
You must be signed in to change notification settings - Fork 2
CONTRIBUTING: small updates #10
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
Open
cassidyjames
wants to merge
1
commit into
main
Choose a base branch
from
cassidyjames/contributing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,43 @@ | ||
| # Contributing to ROOST | ||
| Thank you for being interested in contributing to ROOST! Together we’re making Trust & Safety tools available to all. Please take a moment to review our Contributing guidelines. | ||
|
|
||
| ## Ways to Contribute | ||
| ### Bugs and docs fixes | ||
| For small, easily reproducible bugs or small documentation changes, you can directly open a PR. Please identify it as a bug or fix in the subject line, and write a succinct commit message. | ||
| Thank you for being interested in contributing to ROOST! Together we’re making Trust & Safety tools available to all. Please take a moment to review our contributing guidelines. | ||
|
|
||
| For medium-sized to big bugs or for feature enhancements, please start with an Issue. _(We don’t yet have an issue template; perhaps you could contribute one?!)_ | ||
| ## Ways to contribute | ||
|
|
||
| If auto-generated Issues don’t provide meaningful suggestions and a way of following up with a human author, we will consider these spam and close them. | ||
| ### Small fixes | ||
|
|
||
| ### Code contributions | ||
| Code contributions and significant pieces of documentation (aka Pull Requests) should have a corresponding Issue. We do this to make sure there’s lazy consensus on an idea before someone puts effort behind it, and let the community give feedback on the design. | ||
| If you’re eager to start contributing code to ROOST, start with an open Issue! | ||
| For small, easily reproducible bugs or small documentation changes, you may directly open a PR. Please identify it as a fix in the title, and write a succinct explanation of the change in the description. | ||
|
|
||
| For medium- to large-sized bugs, feature enhancements, or larger documentation changes, please start by **creating an issue**. | ||
|
|
||
| If issues are overly verbose/difficult to parse, don’t provide meaningful suggestions, and/or don't provide a reliable way to follow up with a human author, project maintainers may consider these spam and close them. | ||
|
|
||
| ### Nontrivial contributions | ||
|
|
||
| **Pull requests with nontrivial code or documentation contributions should be linked to a corresponding issue.** We do this to ensure there’s lazy consensus on an idea before someone puts effort behind it, to enable the community give feedback on the design, to aid triage and prioritization, and to improve milestone tracking and release management. | ||
|
|
||
| If you’re eager to start contributing code to ROOST, start with an open issue! | ||
|
|
||
| ### Tutorials and demos | ||
| We’re excited to see you try ROOST tools! For now, please start Tutorial or Demo contributions as Issues. This bird is young and we’re still building our nest. We’ll help find a good place for these on a case-by-case basis. | ||
|
|
||
| We’re excited to see you try ROOST tools! For now, please start tutorial or demo contributions as a GitHub Discussion. This bird is young and we’re still building our nest. We’ll help find a good place for these on a case-by-case basis. | ||
|
|
||
| ### Testing and code review | ||
| Even if you don’t have merge permissions on ROOST repos, you can still help by reviewing code. This means reviewing PRs, their corresponding Issues, and validating solutions, and providing feedback and suggestions to the author. | ||
| General ideas | ||
| Have a thought but not sure it’s “Issue ready”? Throw it in a GitHub Discussion or our Discord channel! | ||
|
|
||
| Even if you don’t have merge permissions on ROOST repos, you can still help by reviewing code. This means reviewing PRs and their corresponding issues, validating solutions, and providing feedback and suggestions to the author. | ||
|
|
||
| ### General ideas | ||
|
|
||
| Have a thought but not sure it’s “Issue ready”? Share it in a GitHub Discussion or our [Discord server](https://discord.gg/5Csqnw2FSQ)! | ||
|
|
||
| ### AI-assisted coding policy | ||
| Contributors are responsible for submitting original work to ROOST projects. This does not preclude the use of developer tools and aids, including AI coding assistants, but the final product must be the contributor's original work. Regardless of development aids, contributors should always submit work that they can explain and that follow good practices for de-buggable and maintainable code. | ||
|
|
||
| ## Code Review Process | ||
| We follow the principle of two party review, which means that an author cannot “self approve” their submission. While we’re defining our maintainership ladder, a code owner must merge code in. You can help by “+” or “thumbs up” other PRs that you’d like to see merged. | ||
| **Contributors are responsible for submitting original work to ROOST projects.** This does not preclude the use of developer tools and aids, including AI coding assistants, but the final product must be the contributor's original work. Regardless of development aids, contributors should always submit work that they can explain, that is reasonably reviewable by the maintainers, and that follows good practices for debuggable and maintainable code. | ||
|
|
||
| ## Code review process | ||
|
|
||
| We follow the principle of two party review, which means that an author cannot “self approve” their submission. Project [maintainers](https://roostorg.github.io/community/roles#maintainers) or trusted community contributors must review and approve contributions before merging them. | ||
|
|
||
| ROOST is focused on building high-quality, functional infrastructure tooling. That means that not every feature or refactor is going to be accepted right now (even if it’s a good idea long term). Please be gracious if your proposal is tabled or added to the future roadmap instead of merged. | ||
| ROOST is focused on building high-quality, functional infrastructure tooling. That means that not every feature or refactor is going to be accepted right now (even if it’s a good idea long term). Please be gracious if your proposal is put on hold or added to the future roadmap instead of merged. | ||
|
|
||
| Thank You! | ||
| Thank you! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fun fact: tabled means opposite things depending on where you are! In the UK it means to put forward for discussion (i.e. put on the table in front of the group), but in the US it means to put it on hold (i.e. put on the table in the corner instead of discussing it). I think in Canada it's even more confusing: in parliament they use the UK meaning, but in business they use the US meaning. 🙃
Best to avoid the idiom.