Skip to content

contributing.md

Latest commit

 

History

History
66 lines (48 loc) · 1.92 KB

contributing.md

File metadata and controls

66 lines (48 loc) · 1.92 KB

Contributing to N1ne Tails

We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or proposing new features, your help is appreciated.

🧰 Before You Start

  • Make sure you've read our LICENSE and agree to its terms.
  • If you plan to submit major changes, open an issue first to discuss your proposal.

🛠 How to Contribute

  1. Fork the repository
    Click the "Fork" button on the top right of the GitHub page.

  2. Clone your fork

    git clone https://github.com/{your-username}/n1netails.git
cd n1netails

  3. Create a new branch

    git checkout -b feature/your-feature-name

  4. Make your changes Make sure your code matches the existing style. Add tests if appropriate.

  5. Commit your changes

    git commit -m "Your clear and concise commit message"

  6. Push to your fork

    git push origin feature/your-feature-name

  7. Submit a Pull Request to the original repository

    • Go to your fork on GitHub.

    • Click "Contribute" → "Open pull request".

    • Select:

      • base repository: n1netails/n1netails
      • base branch: main
      • compare branch: your-username:feature/your-feature-name

    • Provide a clear title and detailed description of your changes.

⚠️ NOTE: Opening a pull request between branches in your fork (e.g., feature → main in your repo) does not update the original project. Make sure your PR targets the upstream repository!

✅ Code Guidelines

  • Keep pull requests focused and atomic.
  • Follow the code style used in this project.
  • Include or update tests when relevant.
  • Make sure the build and tests pass locally.

🗣 Feedback & Reviews

Your pull request will be reviewed by a maintainer. We may request changes before merging.

Thanks for your contribution! 🚀