Contributions are welcome and appreciated! Every little bit helps, and credit will always be given.
If you are new and want to find easy tickets to work on, check easy issues
When contributing to this project (such as code, bugs, documentation, etc.) you agree to the Developer Certificate of Origin and its license (see the apache-2.0.LICENSE file). The same approach is used by the Linux Kernel developers and several other projects.
For commits, it is best to simply add a line like this to your commit message, with your name and email:
Signed-off-by: Jane Doe <[email protected]>
Please try to write a good commit message, see good commit message wiki for details. In particular use the imperative for your commit subject: think that you are giving an order to the codebase to update itself.
To send feedback or ask a question, `file an issue <issues_>`_
If you are proposing a feature:
- Explain how it would work.
- Keep the scope simple possible to make it easier to implement.
- Remember that your contributions are welcomed to implement this feature!
For other questions, discussions, and chats, we have:
- an official Gitter channel at https://gitter.im/aboutcode-org/discuss Gitter also has an IRC bridge at https://irc.gitter.im/ This is the main place where we chat and meet.
- an official #aboutcode IRC channel on Libera Chat (server web.libera.chat) for scancode and other related tools. You can use your favorite IRC client or use the web chat at https://web.libera.chat/?#aboutcode .
- a mailing list at sourceforge
When reporting a bug please include:
- Your operating system name, version and architecture (32 or 64 bits).
- Your Python version.
- Your Saneyaml version.
- Any additional details about your local setup that might be helpful to diagnose this bug.
- Detailed steps to reproduce the bug, such as the commands you ran and a link to the code you are scanning.
- The errors messages or failure trace if any.
- If helpful, you can add a screenshot as an issue attachment when relevant or some extra file as a link to a Gist.
Documentation can come in the form of wiki pages, docstrings, blog posts, articles, etc. Even a minor typo fix is welcomed. See also extra documentation on the Wiki.
If you need a code review or feedback while you are developing the code just create a pull request. You can add new commits to your branch as needed.
For merging, your request would need to:
- Include unit tests that are passing (run
py.test). - Update documentation as needed for new API, functionality etc.
- Add a note to
CHANGELOG.rstabout the changes. - Add your name to
AUTHORS.rst.
To run a subset of test functions containing test_myfeature in their name use:
py.test -k test_myfeature
To run tests verbosely, displaying all print statements to terminal:
py.test -vvs