Skip to content

Latest commit

 

History

History
80 lines (46 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

80 lines (46 loc) · 1.94 KB
Raw

Contributing to KeelNut

🎉 Thank you for considering contributing to KeelNut! 🎉

KeelNut is an open-source project, and we welcome contributions from the community. Whether you are a developer, designer, tester, or someone with great ideas, your involvement is valuable.

How to Contribute

Issues

  1. Bug Reports:

    • If you find a bug, please check the existing issues to see if it has already been reported.
    • If not, create a new issue with a clear description of the bug, steps to reproduce, and expected behavior.

  2. Feature Requests:

    • Suggest new features or improvements by opening a new issue.
    • Clearly describe the proposed feature and how it benefits the project.

  3. Questions and Discussions:

    • If you have questions or want to discuss something related to KeelNut, create a new issue.

Pull Requests

  1. Fork the Repository:

    • Fork the KeelNut repository to your GitHub account.

  2. Clone your Fork:

    • Clone your fork to your local machine.
    git clone https://github.com/your-username/KeelNut.git

  3. Create a Branch:

    • Create a new branch for your contribution.
    git checkout -b feature/your-feature

  4. . Make changes:

    • Make your changes to the code.

  5. Commit Changes:

    • Commit your changes with a descriptive commit message.
    git commit -m "Add your message here"

  6. Push Changes:

    • Push your changes to your fork.
     git push origin feature/your-feature

  7. Create a Pull Request:

    - Open a pull request from your fork to the main branch of the KeelNut repository.

    🚨 Please ensure that your pull request adheres to the project's coding standards and guidelines.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct.

License

KeelNut is licensed under the MIT License.

🚀 Happy coding! 🚀