First off, thank you for considering contributing to AMDAT! Please take a moment to review this document before submitting a pull request.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
AMDAT is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into AMDAT itself.
Please ask first before starting work on any significant new features.
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create a feature request to first discuss any new ideas. Your ideas and suggestions are welcome!
For any questions, support, or ideas, etc. please create a GitHub discussion. If you've noticed a bug, please submit an issue.
If this is something you think you can fix, then [fork AMDAT] and create a branch with a descriptive name.
Develop and test your fix on your fork. At this point, you're ready to make your changes. Feel free to ask for help.
At this point, if your changes look good and tests are passing, you are ready to create a pull request.
A pull request can only be merged into main by a maintainer if standard tests are passing, approved by another maintainer and is up to date with the default branch. Any maintainer is allowed to merge a pull request if all of these conditions are met.
Maintainers need to do the following to push out a release:
- Create a feature branch from main and make sure it's up to date.
- Run standard test suite.
- Review and merge the PR.
- Create a GitHub Release by selecting the tag and generating the release notes.