Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
132 lines (85 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

132 lines (85 loc) · 3.79 KB

Contribution Guidelines

Thank you for considering contributing to the drf-restwind! We appreciate your interest in helping us make this project better. Please take a moment to review these guidelines before submitting your contributions.

Code of Conduct

We adhere to a Code of Conduct to ensure a welcoming and respectful environment for all contributors. Please read and follow the guidelines outlined there.

Getting Started

Before you can contribute, you’ll need to set up your development environment:

  1. Clone the Repository:

    git clone https://github.com/youzarsiph/drf-restwind.git
cd drf-restwind

  2. Set Up the Environment:

    • Install Poetry if not already installed:

      pip install poetry

    • Install the project dependencies:

      poetry install

  3. Running the Application:

    poetry run python app/main.py

  4. Code Formatting:

    • Ensure all code is formatted with Black:

      poetry run black .

  5. Code Linting:

    • Ensure all code is linted using Ruff:

      poetry run ruff .

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please open an issue. When reporting:

  • Provide a clear and detailed description of the issue.
  • Include steps to reproduce the problem if applicable.
  • Mention the version of the software and your operating system.

Pull Requests

We welcome pull requests that address issues or implement new features. Before you start:

  1. Check for Open Issues:

    • Ensure the issue you want to address has not already been addressed.

  2. Create a New Issue:

    • If the issue does not exist, create a new one to describe the problem or the feature you plan to implement.

  3. Fork the Repository:

    • Fork the repository to your GitHub account.

  4. Create a New Branch:

    • Create a new branch for your changes:

      git checkout -b feature/your-feature-name

  5. Make Your Changes:

    • Implement your changes in the new branch.

  6. Run Tests:

    • Verify that all tests pass and that your changes do not introduce new issues.

  7. Commit Your Changes:

    • Commit your changes with a descriptive message:

      git commit -m "Add new feature: your feature name"

  8. Push to Your Fork:

    • Push your changes to your forked repository:

      git push origin feature/your-feature-name

  9. Create a Pull Request:

    • Open a pull request to the original repository. Ensure you reference the issue number you are addressing.
    • Provide a clear description of what your pull request does and why it should be merged.

Continuous Integration

We use GitHub Actions for continuous integration:

  • Code Style (Black): Checks if the code is formatted according to Black.
  • Code Linting (Ruff): Ensures the code adheres to the linting rules set by Ruff.

If your pull request does not pass these checks, please fix the issues and push the changes.

Code Review

Once a pull request is opened, it will be reviewed by one or more maintainers. Please be patient and responsive to feedback to ensure your changes are merged efficiently.

License

By contributing to the drf-restwind, you agree that your contributions will be licensed under the MIT License.

Support

For any questions or assistance, you can:

  • Visit the GitHub Discussions.
  • Open an issue in the Issues section.
  • Reach out to the maintainers directly if necessary.

Thank you for your contributions! We look forward to working with you.