diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2a789c1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing Guidelines + +Welcome to our community! We appreciate your interest in contributing to our project. By participating here, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions. + +## How to Contribute + +We value all contributions, whether they come in the form of bug reports, feature suggestions, code contributions, or anything else. Here's how you can contribute: + +### Bug Reports + +If you encounter a bug in the project, please report it by opening an issue on our [issue tracker](https://github.com/dadegrande99/AlignmentFreeSequence-to-Graph/issues). Make sure to include detailed steps to reproduce the bug, along with any relevant information about your environment. + +### Feature Requests + +Have an idea for a new feature or an improvement? We'd love to hear it! Open an issue on our [issue tracker](https://github.com/dadegrande99/AlignmentFreeSequence-to-Graph/issues) and share your thoughts. Be sure to provide as much detail as possible about the feature you're proposing. + +### Code Contributions + +If you'd like to contribute code to the project, follow these steps: + +1. Fork the repository to your GitHub account. +2. Create a new branch for your feature or bug fix. +3. Make your changes, following our [coding standards](#coding-standards). +4. Test your changes thoroughly. +5. Commit your changes and push them to your fork. +6. Submit a pull request to our repository. + +Our team will review your pull request as soon as possible. Please be patient and be prepared to make any necessary changes based on our feedback. + +### Other Contributions + +If you have other contributions in mind, such as documentation improvements, testing assistance, or community outreach, feel free to reach out to us. We welcome contributions of all kinds! + +## Coding Standards + +When contributing code to our project, please follow these guidelines: + +- Adhere to the style and conventions used throughout the project. +- Write clear, concise, and well-documented code. +- Include tests for any new functionality or bug fixes. + +## Questions? + +If you have any questions about contributing to our project, don't hesitate to reach out. You can contact us by opening an issue on our [issue tracker](https://github.com/dadegrande99/AlignmentFreeSequence-to-Graph/issues). + +Thank you for your interest in contributing to our project, and for helping us maintain a welcoming and inclusive community!