Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (30 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

38 lines (30 loc) · 1.42 KB

Contributing to PITT

We welcome contributions from the community! Whether you're fixing a bug, adding a new feature, or improving the documentation, your help is appreciated.

How to Contribute

  1. Fork the repository: Create your own fork of the PITT repository.
  2. Create a new branch: 
    git checkout -b feature/your-new-feature
  3. Make your changes: Make your changes to the codebase.
  4. Commit your changes: 
    git commit -m "feat: Add some amazing feature"
  5. Push to your branch: 
    git push origin feature/your-new-feature
  6. Create a new Pull Request: Open a pull request from your fork to the main PITT repository.

Reporting Bugs

If you find a bug, please open an issue on the GitHub repository. Please include the following information in your bug report:

  • A clear and descriptive title.
  • A detailed description of the bug, including the steps to reproduce it.
  • The expected behavior and the actual behavior.
  • Any relevant error messages or logs.

Suggesting Enhancements

If you have an idea for a new feature or an enhancement to an existing feature, please open an issue on the GitHub repository. Please include the following information in your enhancement suggestion:

  • A clear and descriptive title.
  • A detailed description of the proposed enhancement.
  • Any relevant mockups or examples.

Thank you for your contributions!