CONTRIBUTING.md

Contributing to ReTiSAR

Do you want to request a feature?

1. Ensure the feature was not already requested by searching on GitHub under Issues.

2. If you're unable to find an open issue addressing the feature, open a new one. Be sure to include a title and clear description, as much relevant information as possible.

3. If possible, use the relevant feature request templates to create the issue.

Do you want to report a bug?

1. Ensure the bug was not already reported by searching on GitHub under Issues.

2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

3. If possible, use the relevant bug report templates to create the issue.

Do you want to write a patch that implements a feature or fixes a bug?

Please refer to the project's style guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repository on GitHub.

2. Clone your forked project to your own machine.

3. Create a new branch for the feature or bug you are working on.

4. Validate written code to conform with the chosen Black code convention.

• Install additionally required Python packages into Conda environment:
  conda env update --file environment_dev.yml
• Perform code style analysis:
  black ReTiSAR/*.py

5. Commit changes to your own branch.

6. Push changes to your own fork.

7. Submit a Pull request to the original project so we can review your changes.

• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you have questions about the source code?

• Ask any question about how to use ReTiSAR, get in touch with the AUTHORS.

Do you want to contribute to the documentation?

WIP.