07. How to contribute - gsambrotta/open-matches GitHub Wiki

Thank you for considering to contribute to this project!

To start to contribute I will suggest to read the Motivation, Architecture, Data Model and MVP Scope first so it can be clear what are the scope of this product and it will be easier for you to jump in and support with your ideas. Then i would suggest to read the Development Workflow to understand better how to contribute with your code.

Once all of this is done, you are ready to set up the project. Go ahead and clone the repo and then follow the steps in the readme.

Once you have the project set up properly, i would recommend you to have a quick look at the code and understand the structure.

Then you are finally ready to add your code!

But where to start? Different ways:

  • Go to the issues and find once that you like. I would suggest you to check the ones with good first issue label to get comfortable with the code.
  • If no issues are available, you can check what's the current status of the project in the Project section of this repo. You can check the tasks in the ToDo column. They are already prioritise, based on the MVP scope. Pick up one of those, move to In Progress and start to work on it. If the card is not clear enough, feel free to open an issue asking for clarification.
  • If you have an idea or you found a bug, please open an issue respectively with label bug or ideas and we will discuss it there.

For any other concerns or questions, feel free to open an issue with the label help wanted.

Thank you and have fun!

todo: License