Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 2.53 KB
Raw

Contributing to Project Honeycomb 🐝

Thank you for considering contributing to Project Honeycomb! Here are some guidelines to follow to ensure that your contributions are valuable and smoothly integrated.

Getting Started

To get started, check the good first issues section of the repository to see if there are any open issues that you could help with. If you have a new idea or feature you'd like to propose, please create an issue first to discuss it with the maintainers.

Code of Conduct

Please note that Project Honeycomb has a Code of Conduct that all contributors are expected to follow. Please read it carefully before contributing.

Contribution Guidelines

Here are some general guidelines to follow when contributing to Project Honeycomb:

  • Fork the repository and make your changes in a new branch.
  • Write clear, concise, and well-documented code.
  • Test your changes thoroughly before submitting a pull request.
  • Use Conventional Commits for all commit messages that explain the changes you've made.
  • Submit a pull request, explaining the changes you've made and why they are valuable.

Pull Request Process

Here are the steps to follow when submitting a pull request:

  1. Fork the repository and create a new branch for your changes.
  2. Make your changes and test them thoroughly.
  3. Commit your changes with clear, concise commit messages that explain the changes you've made, following the Conventional Commits format.
  4. Push your changes to your forked repository.
  5. Open a pull request on the main repository and describe the changes you've made and why they are valuable.
  6. Wait for the maintainers to review your changes and merge your pull request.

Code Review

All pull requests will be reviewed by the maintainers of Project Honeycomb. During the review process, the maintainers may ask for changes or request additional information about your contribution. Once your pull request has been reviewed and approved, it will be merged into the main branch.

Translations

Project Honeycomb is written in English, but we're looking for contributors who can help us translate the bot into other languages. If you're interested in translating, please contact the maintainers for more information.

Thank you for contributing to Project Honeycomb! Your help is greatly appreciated.