Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (36 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 1.71 KB

Contributing to Git-Mod 🚀

First of all, thank you for considering contributing to Git-Mod!

Please note that this project is licensed under the UnSetSoft Public License (UPL) 1.0. By contributing, you agree that your modifications are for contributive purposes towards the original project, as stated in the LICENSE.md.

🛠 How to Contribute

1. Reporting Bugs 🐛

  • Check if the bug has already been reported in the Issues section.
  • If not, create a new issue with a clear title and a detailed description, including steps to reproduce the bug.

2. Suggesting Enhancements 💡

  • We are always open to new "mods" for Git! Open an issue to discuss your idea before starting to code.

3. Pull Requests (PRs) 🛠️

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Write your code: Ensure it follows the existing style and is documented in English.
  4. Submit a Pull Request: Provide a clear explanation of your changes and why they are beneficial to the project.

💻 Development Setup

  1. Install dependencies: 
    npm install
  2. Run in development mode (using tsx): 
    npm start -- <command>
  3. Build the project: 
    npm run build

⚖️ License Agreement

By contributing to Git-Mod, you acknowledge and agree that:

  • Your modifications are made solely for the benefit of the original project (UPL 1.0 Section 3.1).
  • You may not distribute modified versions of this software independently (UPL 1.0 Section 3.2).
  • Your contribution will be licensed under the same UnSetSoft Public License (UPL) 1.0.

Thank you for helping us make Git-Mod even better!