Contributing to AgE

Thank you for your interest in improving AgE3.

Contributing code

  1. Preferably, create an issue describing what you plan to do.
  2. Fork the project as described here.
  3. Create your own, separate branch, based on develop, if you are creating a new feature, or on master or an appropriate release branch, if you are fixing a bug.
  4. Work on your code.
  5. Push your changes and create a merge request to the source branch. - The branch used for merge request need to be rebased on the current commit in the source branch. - Your commit messages should reference your issue ID using refs #id or fixes #id (see Gitlab docs).

When writing commit messages, please follow these guidelines.

For recommendations on the code style see coding guidelines. We also suggest using the IDE configuration that is provided in the .ide directory in the main repository directory.

Issues

We use the following component labels:

  • ~Compute
  • ~Core
  • ~Documentation

We use the following types of issues that should be assigned to issues other than ~Documentation:

  • ~bug
  • ~feature
  • ~maintenance

Contributing documentation

As documentation is located in the same repository, follow the usual contributing guidelines for code.

When writing Markdown docs, please follow this style guide.