Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

71 lines (42 loc) · 3.05 KB
Raw

Contributing to [Your Project Name]

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to our project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to Slack.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for our project. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Explain which behavior you expected to see instead of the problematic behavior.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.
  • Explain why this enhancement would be useful to most users.

Your First Code Contribution

Unsure where to begin contributing to our project? You can start by looking through these beginner and help-wanted issues:

Pull Requests

When you're ready to start working on an issue, follow these steps:

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Style Guides

Git Commit Messages

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

Code Style

Please follow the coding style used throughout the project. Ensure your code is well-documented, with comments where necessary.

Licensing

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

Additional Notes

Issue and Pull Request Labels

We use labels to help organize and prioritize issues and pull requests. Feel free to apply labels that you find appropriate.

Thank you for contributing!