Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (48 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

78 lines (48 loc) · 1.94 KB
Raw

Contributing to pylo

Thank you for your interest in contributing to pylo! We welcome contributions from the community to improve the project.

How to Contribute

1. Fork the Repository

  • Click the Fork button at the top right of the repository page.

  • Clone your fork to your local machine:

    git clone https://github.com/your-username/pylo.git
cd pylo

2. Create a Branch

  • Create a new branch for your feature or bugfix:

    git checkout -b my-feature-branch

3. Make Changes

  • Make your changes or additions.
  • Make sure your code follows the existing style and includes appropriate tests and documentation.

4. Commit Your Changes

  • Commit your changes with a clear message:

    git add .
git commit -m "A concise, descriptive commit message"

5. Push to Your Fork

  • Push your branch to your forked repository:

    git push origin my-feature-branch

6. Open a Pull Request

  • Go to the original repository on GitHub.
  • Click Compare & pull request next to your branch.
  • Fill in the pull request template, describing your changes and why they’re needed.
  • Submit the pull request.

Code of Conduct

By participating in this project, you agree to abide by our code of conduct.

Reporting Issues

  • If you find a bug or have a feature request, please open an issue.
  • Provide as much detail as possible, including steps to reproduce, expected behavior, and screenshots if applicable.

Style Guide

  • Follow PEP8 for Python code.
  • Document functions and classes with docstrings.
  • Use meaningful variable and function names.

License

By contributing, you agree that your contributions will be licensed under the same license as the project.

Questions?

If you have any questions, feel free to open an issue or contact the maintainers.

Happy coding! 🚀