CONTRIBUTING.md

Contributing

This is an active repository and hence we invite developers to contribute in developing this model further.

A contribution can be one of the following cases:

1. you have a question;
2. you think you may have found a bug (including unexpected behavior);
3. you want to make some kind of change to the code base (e.g. to fix a bug, to add a new feature, to update documentation);
4. you want to make a new release of the code base.

The sections below outline the steps in each case.

You have a question

1. use the search functionality here to see if someone already filed the same issue;
2. if your issue search did not yield any relevant results, make a new issue;
3. apply the "Question" label; apply other labels when relevant.

You think you may have found a bug

1. use the search functionality here to see if someone already filed the same issue;
2. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
   • the SHA hashcode of the commit that is causing your problem;
   • some identifying information (name and version number) for dependencies you're using;
   • information about the operating system;
3. apply relevant labels to the newly created issue.

You want to make some kind of change to the code base

1. (important) announce your plan to the rest of the community before you start working. This announcement should be in the form of a (new) issue;
2. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions here and here);
3. update or expand the documentation;
4. update the CHANGELOG.md file with change;
5. push your feature branch to (your fork of) the AWE-Eco repository on GitHub;
6. create the pull request, e.g. following the instructions here.

You want to make a new release of the code base

To create release you need write permission on the repository.

1. Check and contact the authors listed in CITATION.cff
2. Update the CHANGELOG.md to include changes made
3. Goto GitHub release page
4. Press Create a new release button
5. Fill version, title and description field
6. Press the Publish Release button

Acknowledgements

The contribution guidelines are based on the guidelines given in this example.