Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (46 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 2.18 KB
Raw

Contributing to Clancy

First off, thank you for considering contributing to Clancy! It's people like you that make this project possible.

Table of Contents

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue on the GitHub repository. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue on the GitHub repository. Describe the enhancement in detail and explain why it would be useful.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a pull request on the GitHub repository.

Development Setup

  1. Clone the repository: git clone https://github.com/zacharyarney/clancy.git
  2. Navigate to the project directory: cd clancy
  3. Install dependencies: npm install
  4. Build the project: npm run build
  5. Run tests: npm test

Style Guides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the indicative mood ("Moves cursor to..." not "Move cursor to...").
  • Limit the first line to 72 characters or fewer.
  • Reference issues and pull requests liberally after the first line.

Code Style

  • Follow the existing code style.
  • Use eslint to lint your code: npm run lint.
  • Use prettier to format your code: npm run format.

License

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