Spla project contributing guide

January 18, 2023 ยท View on GitHub

Thank you very much if you have decided to contribute to our project. We follow very simple and clear open-source research community accepted guidelines for contributing. The guideline instructions divided into sections depending on the part of the project you want to contribute.

Source code developers guide (1)

  1. Fork this repository using your GitHub account.
  2. Install git and clone your forked copy of the repo.
  3. Build project following build instructions in README.md file, make sure everything is ok.
  4. Run unit-tests following instructions in README.md file, make sure all tests passing.
  5. Implement new feature or fix existing one in the C/C++ source code.
  6. Commit your changes.
  7. Open a pull-request following repository template rules.
  8. Wait for review from developers of the project.
  9. Fix major and minor issues if presented.
  10. Get your work merged into main!

Documentation improvements guide (2)

  1. Fork this repository using your GitHub account.
  2. Install git and clone your forked copy of the repo.
  3. Edit code documentation in source files and/or in docs folder files.
  4. Commit your changes.
  5. Open a pull-request following repository template rules.
  6. Wait for review from developers of the project.
  7. Fix major and minor issues if presented.
  8. Get your work merged into main!

If you want to fix something, ask a question, add new functionality or feature, have a look at our templates.