Contributing to ScanCode.io

Thank you so much for being so interested in contributing to ScanCode.io. We are always on the lookout for enthusiastic contributors like you who can make our project better, and we’re willing to lend a helping hand if you have any questions or need guidance along the way. That being said, here are a few resources to help you get started.

Note

By contributing to the ScanCode.io project, you agree to the Developer Certificate of Origin.

Do Your Homework

Before adding a contribution or create a new issue, take a look at the project’s README, read through our documentation, and browse existing issues, to develop some understanding of the project and confirm whether a given issue/feature has previously been discussed.

Ways to Contribute

Contributing to the codebase is not the only way to add value to ScanCode.io or join our community. Below are some examples to get involved:

First Timers

You are here to help, but you’re a new contributor! No worries, we always welcome newcomer contributors. We maintain some good first issues and encourage new contributors to work on those issues for a smooth start.

Tip

If you’re an open-source newbie, make sure to check the extra resources at the bottom of this page to get the hang of the contribution process!

Code Contributions

For more established contributors, you can contribute to the codebase in several ways:

  • Report a bug; just remember to be as specific as possible.

  • Submit a bug fix for any existing issue.

  • Create a new issue to request a feature, submit a feedback, or ask a question.

Note

Make sure to check existing issues, and FAQs to confirm whether a given issue or a question has previously been discussed.

Tip

Cleanup your code before submitting changes using the make valid command to ensure the proper code format and imports order.

Documentation Improvements

Documentation is a critical aspect of any project that is usually neglected or overlooked. We value any suggestions to improve ScanCode.io documentation.

Tip

Our documentation is treated like code. Make sure to check our writing guidelines to help guide new users.

Other Ways

You want to contribute to other aspects of the ScanCode.io project, and you can’t find what you’re looking for! You can always discuss new topics, ask questions, and interact with us and other community members on Gitter.

Helpful Resources