How to contribute to the code

[FMassin]

We are proud to maintain the SED EEW SeisComP contributions as an open-source project for common interest ✊🤓. To allow your contributions if provided via a pull request (https://docs.github.com/en/get-started/quickstart/contributing-to-projects), you should follow the following rules:

1. Include a minimal description of the changes in the CHANGELOG.md 🤓
2. Make sure compilation, and the included unit test playback (which needs a few minutes), both build successfully (https://docs.docker.com/engine/reference/commandline/build/):

   docker build --pull --rm -f "Dockerfile" -t sedeewseiscompcontributions:latest "." 

3. Make sure all software features are documented:
   • All illustrations in doc/base/media/
   • Overall package description in doc/templates/index.rst
   • General algorithm descriptions in doc/base/<algorithm>.rst
   • General module descriptions in doc/apps/<module>.rst
   • Module parameter descriptions in apps/eew/<module>/descriptions/<module>.xml
   • Test documentation with (requires sphinx installed):

     cd doc
     ./build-doc.py ./ &&  open build-doc/html/index.html

4. Submit your contribution via a pull request from a branch of a fork, see the example below: How to contribute to the code #5 (comment)
5. Please make sure your commits and pull requests are properly described following common best practices such as https://www.atlassian.com/blog/git/written-unwritten-guide-pull-requests.
6. Know that the title of your pull request will be used as the default merge message for all squashed commits (https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests).

Please also be patient with the maintenance team 😓, and remember that your help is very welcomed 🙏!

[FMassin]

How to PR from fork branch

1. Create a fork of the main project online at https://github.com/SED-EEW/SED-EEW-SeisComP-contributions

2. Clone the main project, and go in the clone:

   git clone https://github.com/SED-EEW/SED-EEW-SeisComP-contributions.git
   cd SED-EEW-SeisComP-contributions/

3. Setup pushing to your fork (e.g., with mine, have your own instead):

   git remote set-url --add --push origin https://github.com/FMassin/SED-EEW-SeisComP-contributions.git

4. Push your contribution to a branch of your fork:

   git checkout -b <contrib name>
   git add <files with contrib>
   git commit 
   git push origin  <contrib name>

   Note that git provides a direct link to create your pull request, e.g.:

   ...
   remote: Create a pull request for 'sceewdump' on GitHub by visiting:
   remote:      https://github.com/FMassin/SED-EEW-SeisComP-contributions/pull/new/sceewdump 
   ...

Bonus

Project owners might push minor contribution from their master branch to both their forks and the main project repo:

git push all master