Since we welcome PRs from all developers, we should add a section to the main README.md file about contributing to this repository. This section should guide developers and help them avoid common issues, for example making sure that commits are made to the proper branch (e.g. here).
We can also encourage developers to write comprehensive descriptions of what they are improving/fixing with their PR.
Finally, we could add a section about the proper way to submit bugs, for example specifying how to post comprehensive logs of the error/output.
What needs to get done
Add new section called "Contributing" in README.md
Add a paragraph about choosing the correct branch/version before submitting a PR
Add a paragraph about properly creating a new bug issue
Definition of Done
The README.md has a new section named "Contributing", with notes that help developers contribute/submit issues to the repository.
Context
Since we welcome PRs from all developers, we should add a section to the main README.md file about contributing to this repository. This section should guide developers and help them avoid common issues, for example making sure that commits are made to the proper branch (e.g. here).
We can also encourage developers to write comprehensive descriptions of what they are improving/fixing with their PR.
Finally, we could add a section about the proper way to submit bugs, for example specifying how to post comprehensive logs of the error/output.
What needs to get done
Definition of Done
The README.md has a new section named "Contributing", with notes that help developers contribute/submit issues to the repository.