Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Sayad Uddin Tahsin <[email protected]>
  • Loading branch information
Sayad-Uddin-Tahsin committed May 4, 2023
1 parent c9a9133 commit ae11a3f
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to sra-pylib

We welcome contributions to sra-pylib! Whether you want to report a bug, suggest an enhancement, or submit code changes, we appreciate your input.

## Reporting Bugs

If you encounter a bug in sra-pylib, please open an issue on our GitHub repository. Be sure to include as much detail as possible about the bug, including:

- A description of what you were doing when the bug occurred
- The error message you received (if applicable)
- Steps to reproduce the bug
- Any other relevant information

Reporting bugs is highly appreciated as it helps us improve the library.

## Suggesting Enhancements

If you have an idea for how to improve sra-pylib, please open an [issue](https://github.com/Sayad-Uddin-Tahsin/sra-pylib/issues) on our GitHub repository. Be sure to include a detailed description of your suggestion and any relevant information.

## Contributing Code

If you want to contribute code to sra-pylib, please follow these steps:

- Fork the sra-pylib repository on GitHub.
- Clone your fork of the repository to your local machine.
- Create a new branch for your changes.
- Make your changes and test them locally.
- Push your changes to your fork of the repository.
- Create a pull request to merge your changes into the main repository.

Before submitting a pull request, please ensure that your code follows our coding style and that all tests pass.

## Coding Style

We follow the [Python Style Guide](https://peps.python.org/pep-0008/) for our Python code. Please ensure that your code follows this style guide before submitting a pull request.

## Code of Conduct

We expect all contributors to adhere to our [Code of Conduct](https://github.com/Sayad-Uddin-Tahsin/sra-pylib/blob/main/CODE_OF_CONDUCT.md). Please read it before contributing.

Thank you for contributing to sra-pylib!

0 comments on commit ae11a3f

Please sign in to comment.