decryptofy
commented
5 months ago Your efforts are appreciated. For the contribution process, we should also add:
- For newly added Python source code files, to include the Mozilla Public License 2.0 (no copyleft exception) header
- For newly included Python packages, to run liccheck -s license_check.ini to make sure that only license-compatible projects are included (next step: include that as a GitHub action)
- For new contributors that add/modify/extend source code files under the MPL 2.0 license, to include themselves in the list of contributors in the README.md (i.e., the term contribution and contributor follow the MPL 2.0 license definitions)
I'm looking forward to your contribution!
Hello! The purpose of this issue is to request expansion of the documentation in the contributor’s guide to formalize it. The “Contributing Process” is clearly stated as TBD, but it would be helpful to potentially add more specificity to the contributor’s guide, perhaps via a more extensive description of how to contribute to each of the following: development, documentation, feature requests, patches, bug reporting, and user support. It may be even more helpful to include links to pull requests and successful prior instances of each form of contribution for future contributors to look to for guidance. Below is one possible way to begin adding more detail to the Contributor’s Guide:
Another idea to improve this documentation through the same lens is to include a “Steps to a Successful Developer Contribution” section. I have seen some large and successful open-source projects include one as part of their documentation for contributors. The idea below could potentially be a starting point to introduce this:
I plan to follow up on this suggestion in the coming weeks with pull requests that will outline specific, actionable, and more thorough changes for others to review and refine.