Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.62 KB

contribution_guidelines.md

File metadata and controls

48 lines (30 loc) · 2.62 KB
Raw

Contributing Guidelines

Welcome to the Nuggt project! We appreciate your interest in contributing. By contributing to Nuggt, you can help improve the project, add new features, fix issues, and make it even more powerful for the community.

To ensure a smooth and collaborative experience, please follow these guidelines when contributing to Nuggt:

Code of Conduct

We have a Code of Conduct in place to promote a friendly and inclusive environment. Please review and abide by it in all interactions and contributions within the project.

Ways to Contribute

There are several ways you can contribute to Nuggt:

  • Bug Reports: If you encounter a bug or unexpected behavior, please submit an issue with detailed information about the problem, including steps to reproduce it.
  • Feature Requests: If you have an idea for a new feature or enhancement, open an issue and describe your suggestion. We value your input!
  • Pull Requests: If you would like to contribute code to Nuggt, you can submit a pull request (PR) with your changes. Before submitting a PR, make sure to read the next section on the development process.

Development Process

Follow these steps to contribute code through a pull request:

  1. Fork the Nuggt repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes: git checkout -b my-branch.
  4. Make your desired changes or additions to the codebase.
  5. Test your changes to ensure they work as intended.
  6. Commit your changes: git commit -m "Add feature or fix".
  7. Push your changes to your forked repository: git push origin my-branch.
  8. Open a pull request from your forked repository to the main Nuggt repository.

Please ensure that your code adheres to the project's coding conventions. It's also helpful to include a clear and concise description of your changes in the pull request.

Community and Communication

We encourage active participation and welcome discussions related to Nuggt. You can join in by:

  • Engaging in conversations and raising questions in the GitHub issues section.
  • Contributing to discussions and sharing ideas on the Nuggt community forum. (Coming Soon)
  • Following the project's official blog for updates, tutorials, and announcements. (Coming Soon)

Thank you for considering contributing to Nuggt! Your contributions play a vital role in making this project successful.

Support

If you need any assistance or have any questions about contributing, please don't hesitate to reach out to our support team at Discord Server.

We appreciate your contributions and look forward to collaborating with you!