Thanks

Thank you for considering contributing to GrPPI. Our aim is to make GrPPI useful for the software community at large. Any kind of contribution is highly appreciated.

Why should you read this guideline?

Following this guideline will help you to keep contact with GrPPI team. This will result in shorter time to process your bug reports, suggestions and pull requests.

Ways of contributing to GrPPI

You may contribute in a number of ways, including:

• Filing bug reports.
• Suggesting new features.
• Contributing with documentation.
• Contributing with with improved implementation of patterns or back ends.
• Contributing with unit test cases.
• Contributing with sample applications.

Contributing go GrPPI

General rules

• Please read and follow the GrPPI Code of Conduct before contributing to GrPPI.

If you are contributing with documentation:

• Please, provide improvements as small as possible, as pull requests.
• If a change in documentation structure is needed, we prefer that you file a suggestion.

If you are contributing with code:

• Ensure that your pull request passes all unit tests for the set of supported platforms.
• For minor issues you can submit a pull request without filing and issue.
• For non-trivial issue, please, file an issue that can be discussed before a decision is taken on how to process it.
• Software pull requests should be as small as possible and providing only one feature per pull request.

How to file a bug report

If you find a bug, please create an issue and include the following information:

• Compiler and version that you used.
• Operating system.
• Processor and architecture.
• Smallest use case that can be used to reproduce the bug.
• Results that you obtained and results that you were expecting.

Important: Please, mark the issue with the label bug.

How to suggest a new feature

If you want to suggest a new feature, please create an issue and include the following information:

• Describe the feature that you are expecting.

Important: Please, mark the issue with the label feature.

How to run tests

Before contributing with code, please, make sure that your code passes all unit tests.