hush3/CONTRIBUTING.md

Komodo Core (komodod) Software Contribution Guidelines

Thank you for reaching out and trying to make Komodo an even better software application and blockchain platform. These contribution guidelines shall help you figuring out where you can be helpful and how to easily get started.

Table of Contents

0. Types of contributions we're looking for
1. Ground rules & expectations
2. How to contribute
3. Style guide
4. Setting up your environment
5. Contribution review process
6. Community

Types of contributions we're looking for

There are many ways you can directly contribute to Komodo:

• Debug and test the Komodo Core code
• Find and fix bugs
• Improve suboptimal code
• Extend our software
• Perform a secure code review of Komodo Core and other Komodo-related software

Interested in making a contribution? Read on!

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

• Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
• Open Source Guides are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
• If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
• When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it can contribute to Komodo, do one of the following:

• If your contribution is minor, such as a fixing a typo, open a pull request.
• If your contribution is major, such as a new feature or bugfix, start by opening an issue first. That way, other contributors can weigh in on the discussion before you do any work.

Style guide

Write clear, clean and consistent code. Follow well-known and established style guidelines like Google's C++ Style Guide or Bjarne Stroustrup's C++ Style FAQ.

Setting up your environment

The Komodo Core (komodod) is mainly written in C++ with specific modules written in C. Follow the Getting Started instructions to build komodod from sources. For more informations about the Komodo Platform and a full API documentation please visit the official Komodo developer documentation.

Contribution review process

Our team and community will review your contribution and start a transparent testing and quality assurance process. As soon as your contribution has undergone sucessful review and QA signoff it gets merged into the Komodo sourcecode.

Community

Discussions about Komodo's development take place on our discord server. Anybody is welcome to join these conversations. There is also a newsletter with regular updates.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.

This contribution guideline is adapted from the Open Source Guides.