CONTRIBUTING.md

Thank you for your interest in contributing to this project. This file contains some basic information about possible contributions.

• DotGGPK repository
• DotGGPK issue tracker
• DotGGPK continuous integration

Issues

All issues can be found in the project issue tracker. When reporting new issues please make sure that you do not submit a duplicate and use the appropriate issue template to ensure providing as much information as possible:

• Bug: all kind of wrong software behavior should be reported using this issue template
• Enhancement: if there are any features that work as expected but could be improved please use this issue templates
• Feature: if there are any important features missing use this issue template to propose them
• Question: if you are not sure which issue template should be used or you just have a question about the software please use this template

Code

If you want to contribute code please read the following rules:

Workflow

Since you do not have write access to the repository a project forking workflow is used for external contributions:

0. Create a fork of this project into your own GitLab workspace.
1. Create a feature branch based on the master branch, preferably with the issue number and a description in the name (e.g. 123-my-feature).
2. Comment the issue you will work on and link your feature branch.
3. Submit a merge request to the master branch using the merge request template; make sure you completed the checklist in the template and mention the issue solved by this merge request to auto-close it when the branch has been merged. Use the work in progress indicator while working on the issue.

Acceptance criteria

• Only submit merge requests for issues tagged as ~accepted
• Obey the StyleCop / CodeAnalysis rules configured in the project solution file
• Write unit tests with a reasonable code coverage
• Obey software architecture and design

Donations

If you like the software consider a donation.