Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

85 lines (54 loc) · 2.88 KB
Raw

Contributing to Hexashades

First off, thank you for considering contributing to Hexashades! I welcome contributions from everyone, whether you're fixing a typo or submitting a major feature. To make the contribution process smooth and consistent, I ask that you follow these guidelines.

Table of Contents

Code of Conduct

By participating in this project, you agree to follow the Code of Conduct. Please read it to ensure a positive experience for everyone.

How to Contribute

Reporting Bugs

If you find a bug in the project, please help by reporting it:

  1. Check the issue tracker to see if the bug has already been reported.
  2. If not, open a new issue with a detailed description of the problem, including steps to reproduce it, your environment (OS, Node.js version, etc.), and any relevant logs or error messages.

Suggesting Enhancements

If you have an idea for a new feature or improvement:

  1. Check if the feature has already been suggested.
  2. If not, open a new issue with a clear description of the enhancement and why it would be useful. I love hearing your ideas!

Submitting a Pull Request

I appreciate your contributions! To submit a pull request (PR), follow these steps:

  1. Fork the repository and create a new branch for your changes.
  2. Write clear, concise commit messages that explain your changes.
  3. Ensure that your code adheres to the project's coding style and passes any existing tests.
  4. If applicable, write tests for your changes and make sure they pass.
  5. Open a pull request against the main branch.

I will review your PR and provide feedback. Be prepared to make revisions if necessary.

Development Setup

To set up the project for local development, follow these steps:

  1. Clone the repository:

    git clone https://github.com/arjunkdot/hexashades.git

  2. Install the dependencies:

    npm install

    or

    pnpm install

    Make sure to follow any additional setup instructions in the README.md if applicable.

Commit Message Guidelines

I follow a simple convention for commit messages:

  • Use the present tense: "Add feature" not "Added feature."
  • Use a short, descriptive message (50 characters or less).
  • If the change is related to an issue, reference the issue number using #.

Example

Please refer to Conventional Commits for more details.

License By contributing to this project, you agree that your contributions will be licensed under the MIT License.