Thank you for your interest in contributing to RePolyA! Every contribution, big or small, can make a significant difference. This guide will help you understand how you can be a part of this project.
- Fork the Repository: Start by forking the RePolyA repository to your account.
- Clone the Fork: Once forked, you can clone your forked repo with
git clone <your-forked-repo-url>
- Create a Virtual Environment: It's good practice to have a separate environment. Depending on your preference, you can use
virtualenvorcondafor this. - Install Dependencies: Run
pip install -r requirements.txtto install the necessary packages.
- Branch Out: Before making changes, create a new branch with a descriptive name:
git checkout -b <branch-name> - Make Your Changes: Ensure you adhere to coding standards and avoid unnecessary changes.
- Commit Your Changes: Make sure to write meaningful commit messages. Use
git commit -m "Descriptive commit message"
- Push to Your Fork: Push your changes to your forked repository with
git push origin <branch-name> - Open a Pull Request (PR): Go to the RePolyA repository and open a new PR. Make sure to provide a detailed description of your changes.
- Be Respectful: All contributors should treat each other with respect.
- Feedback: Always be constructive with feedback. Remember, everyone is here to learn and grow.
Before submitting any changes, ensure your code doesn't break existing functionalities. Run any tests associated with the project.
- Please make sure your code adheres to the project's coding standards.
- If you're suggesting a major change, it's always good to open an issue first to discuss the potential impact and benefits.
Thank you for making RePolyA better!