Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 1.33 KB
Raw

Contributing to [Project Name]

First off, thank you for considering contributing to our project! Your help is essential for keeping it great.

Code of Conduct

Please read and follow our Code of Conduct.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue here and include as much detail as possible.

Suggesting Enhancements

Feel free to suggest enhancements by opening an issue here.

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.

Development Setup

  1. Clone the repository: git clone https://github.com/your-username/your-repo.git
  2. Navigate to the project directory: cd your-repo
  3. Install dependencies: npm install (or other relevant command)

Style Guides

Coding Standards

  • Follow the existing code style.
  • Use meaningful variable and function names.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").

Testing

To run tests, use the following command:

npm test