chore: Add contributing and code of conduct documentation [DT-5996] #35
Conversation
This file contains 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
lanesawyer
requested review from
a team,
froyo-np and
crispipear
and removed request for
a team
froyo-np
approved these changes
Nov 13, 2024
|
@AllenInstitute/app-dev It would be good to get a majority of the team's eyes on this to make sure we're all happy with the code of conduct and contributing instructions! |
TheMooseman
approved these changes
Nov 13, 2024
lanesawyer
changed the title
crispipear
approved these changes
Nov 14, 2024
Jarbuckle
reviewed
Nov 20, 2024
CODE_OF_CONDUCT.md
Outdated
| All complaints will be reviewed and investigated promptly and fairly. | ||
|
|
||
| All community leaders are obligated to respect the privacy and security of the | ||
| reporter of any incident. |
There was a problem hiding this comment.
Should there be any mention of a no-retaliation policy here?
There was a problem hiding this comment.
Yeah, that's a good idea. It's implied, but being a little more explicit is helpful!
| @@ -0,0 +1,116 @@ | |||
| # Code of Conduct - Visualization Toolkit | |||
There was a problem hiding this comment.
Unless it's otherwise recommended, I'd suggest removing the extra newlines embedded in each paragraph, so that they flow appropriately in whatever space they're viewed.
There was a problem hiding this comment.
Yeah those are from the Prettier formatting rules. I don't love them either. We could tweak them or ignore .md files from formatting!
CONTRIBUTING.md
Outdated
|
|
||
| - Open an [Issue](https://github.com/AllenInstitute/vis/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) | ||
| - Explain the behavior you would expect and the actual behavior. | ||
| - Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. |
There was a problem hiding this comment.
The phrasing "bug report" seems to be contrary to what was said in the first bullet; maybe "good issue report"?
CONTRIBUTING.md
Outdated
| Once it's filed: | ||
|
|
||
| - The project team will label the issue accordingly. | ||
| - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. |
There was a problem hiding this comment.
Again, "Bugs" maybe should be replaced with "Issues" here, for consistency
CONTRIBUTING.md
Outdated
| - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. | ||
| - **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. | ||
| - You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. | ||
|
|
CONTRIBUTING.md
Outdated
|
|
||
| ### Improving The Documentation | ||
|
|
||
| Documentation improvements are incredibly helpful and welcome. At the moment, we use markdown files on the `docs` folder to document key pieces of the project. At some point we would like to move to a more structured documentation system, but for now, markdown is the way to go when creating new documentation. |
There was a problem hiding this comment.
Suggested change
| Documentation improvements are incredibly helpful and welcome. At the moment, we use markdown files on the `docs` folder to document key pieces of the project. At some point we would like to move to a more structured documentation system, but for now, markdown is the way to go when creating new documentation. | |
| Documentation improvements are incredibly helpful and welcome. At the moment, we use markdown files in the `docs` folder to document key pieces of the project. At some point we would like to move to a more structured documentation system, but for now, markdown is the way to go when creating new documentation. |
CONTRIBUTING.md
Outdated
|
|
||
| ### Linting and Formatting | ||
|
|
||
| We use a linter and code formatter on the project and check for errors. That will largely keep the code style consistent. Make sure to run those checks and fix any issues when opening a PR! |
There was a problem hiding this comment.
Suggested change
| We use a linter and code formatter on the project and check for errors. That will largely keep the code style consistent. Make sure to run those checks and fix any issues when opening a PR! | |
| We use a linter and code formatter on the project to check for errors. That will largely keep the code style consistent. Make sure to run those checks and fix any issues when opening a PR! |
README.md
Outdated
| Contributions are welcome! We're currently breaking apart the Scattebrain component into smaller, more manageable packages. If you have a package that you think would be useful to others, please open a PR. | ||
| Contributions are welcome! We're currently breaking apart the Scatterbrain component into smaller, more manageable packages. If you have a package that you think would be useful to others, please open a PR. | ||
|
|
||
| See the CONTRIBUTING.md file for more information on how to contribute to the project |
There was a problem hiding this comment.
Suggested change
| See the CONTRIBUTING.md file for more information on how to contribute to the project | |
| See the CONTRIBUTING.md file for more information on how to contribute to the project! |
…e for no retaliation policy
Jarbuckle
approved these changes
Nov 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
chore: Add contributing and code of conduct documentation
What
Added
CONTRIBUTING.mdandCODE_OF_CONDUCT.mdto prepare us for open-sourcing the codebaseHow
Used a popular generator site and tweaked it: https://generator.contributing.md/