Skip to content

Latest commit

 

History

History
124 lines (77 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

124 lines (77 loc) · 3.3 KB

Contributing to Pysertive 🌟

Welcome to Pysertive! We're excited to have you contribute. Before you get started, please take a moment to review the following guidelines.


Branch Organization 🌲

We will do our best to keep the main branch in good shape, with tests passing at all times. If you're looking for a task to contribute to, check out the Issues tagged with ready_for_development.


Reporting Bugs 🐞

If you encounter a problem with MarketPipe, you are welcome to open an issue. Before that, please make sure to check if an issue doesn't already exist.


How to Contribute ⚡

  1. Fork the Repository: Click the "Fork" button in the upper right corner of the repository's page on GitHub.

  1. Clone the Repository: Clone your fork of the repository to your local machine using Git:
git clone https://github.com/your-username/pysertive.git

  1. Pick an Issue: Check out the Issues tab and get an issue assigned to you. Simply comment /assign on an issue, and our GitHub Action will automatically assign the issue to you.

  1. Create a Branch: Create a new branch for your contribution:
git checkout -b feature/your-feature

  1. Install Dependencies: Install the necessary dependencies using Poetry. This will also set up pre-commit hooks:
poetry install

  1. Make Changes: Make your changes to the project locally on your computer.

  1. Write Tests: Ensure that your changes are covered by tests. Add new tests if necessary.

  1. Run Tests: Run the tests to ensure that your changes do not break existing functionality:
poetry run pytest

  1. Run Pre-commit Hooks: Ensure your code passes all pre-commit hooks. These hooks will automatically check your code for common issues, type hinting and enforce consistent styling:
poetry run pre-commit run --all-files

  1. Commit Changes: Commit your changes with a descriptive commit message:
git commit -m "Add your message here"

  1. Push Changes: Push your changes to your fork of the repository on GitHub:
git push origin feature/your-feature

  1. Create Pull Request: Go to the pysertive repository on GitHub, and click the "New Pull Request" button. Fill out the necessary information and submit your pull request.

Note: The pull request will be commented with code test coverage results. If the coverage is not 100%, please update the tests to cover the new code.


Get Started 🚦

Prerequisites

Make sure you have the following installed on your machine:


Installing Dependencies

To install the necessary dependencies, run the following commands:

poetry install

And setup local pre-commit hooks:

poetry run pre-commit install

Contact

If you have any questions or need further assistance, feel free to reach out to us.



Thank you for contributing to Pysertive! Together, we can make this project awesome. Let's create something amazing! ✨