We welcome contributions, but request that you follow these guidelines:
Please report any bugs on the project's issue tracker.
- Be sure to search the list to see if your issue has already been raised.
- A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong.
- Provide as much context as possible so we can try to recreate the issue.
- If possible, include screenshots depicting the bug.
If you have any suggestions for new features, please raise them on the project's issue tracker.
We cannot promise to incorporate your suggestions, but we will as minimum respond to the request and either plan it in a future release or make it available for other contributors to tackle.
If you want to raise a pull request with a new feature, or a refactoring of existing code, please make sure that your code follows our coding standards and adheres to our chosen open source software [LICENSE)(https://github.com/DataCloud-project/SIM-PIPE/blob/main/LICENSE), i.e., the Apache License 2.0.
Upon pull requests we use ESLint checker rules to automatically check that the code is properly formatted.
Please also make sure to provide a detailed description of your changes by adding a new section in the CHANGELOG.md file before requesting the pull request.
The pull request will be reviewed by at least one member of the core development team.
At the moment we are using the following branch structure:
- main - This is the main branch for which we integrate new code and create releases. We use the Semantic Versioning 2.0.0 guidelines for versioning the releases.
feature/patch- We create separate branches for each new feature or patch that we are working on based on the latestmainbranch. After the code has been completed and tested, we integrate the work through a pull request.
We use the following coding standards: