Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (25 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 1.18 KB

Contributing to Pytml

First off, thank you for considering contributing to Pytml! 🎉

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment.

How Can I Contribute?

Reporting Bugs

  • Check if the bug has already been reported in Issues.
  • If not, open a new issue with a clear title and description.
  • Include steps to reproduce, expected behavior, and actual behavior.
  • Add screenshots or code snippets if possible.

Suggesting Enhancements

  • Open an issue with the label enhancement.
  • Explain why this enhancement would be useful to most Pytml users.

Pull Requests

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/amazing-feature).
  3. Make your changes. Keep them focused on one thing.
  4. Test your changes locally.
  5. Commit with a clear message (git commit -m 'Add some amazing feature').
  6. Push to your branch (git push origin feature/amazing-feature).
  7. Open a Pull Request against the main branch.

Development Setup

  1. Clone your fork: 
    git clone https://github.com/your-username/pytml.git
cd pytml