Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (44 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

60 lines (44 loc) · 3.22 KB
Raw

Contributing to ColaBOT

First and foremost, thank you! We appreciate that you want to contribute to ColaBOT, your time is valuable, and your contributions mean a lot to us.

Important!

By contributing to this project, you:

  • Agree that you have authored 100% of the content
  • Agree that you have the necessary rights to the content
  • Agree that you have received the necessary permissions from your employer to make the contributions (if applicable)
  • Agree that the content you contribute may be provided under the Project license(s)
  • Agree that, if you did not author 100% of the content, the appropriate licenses and copyrights have been added along with any other necessary attribution.

Pull Request Process

  • Fork the repository and create a new branch for your changes.
  • Make the necessary changes, and commit your code with a clear commit message.
  • Push your changes to your fork.
  • Submit a pull request to the main repository.
  • The repository maintainers will review your pull request and may request changes or improvements.
  • Once the changes have been made and the pull request has been approved, it will be merged into the main branch.

Git Commit Conduct

When writing commit messages, please follow these best practices:

  • Use the imperative mood in your commit message. For example, "Fix bug" instead of "Fixed bug" or "Fixes bug".

  • Avoid using exclamation points or question marks in your commit message.

  • Keep your commit message short and concise, ideally no more than 50 characters.

  • Use the commit message body to provide any necessary context or details about the commit.

  • Use prefixes in your commit messages to make them more semantic. Some common prefixes include:

    • "feat" for new features.
    • "fix" for bug fixes.
    • "perf" for performance improvements.
    • "build" for changes to the build system.
    • "ci" for continuous integration - changes,
    • "docs" for documentation changes.
    • "refactor" for refactoring changes.
    • "style" for formatting changes.
    • "test" for changes to tests.

Reporting Bugs

If you've found a bug, we would appreciate it if you could report it to us. To report a bug, please follow these steps:

  1. Check the existing issues in the repository to see if the bug has already been reported. If it has, you can add your additional information to the existing issue.
  2. If the bug has not been reported, create a new issue and provide a clear and concise description of the problem.
  3. Include any relevant details, such as the version of the extension you are using, the platform you are using (e.g. Windows, Mac, Linux), and the steps to reproduce the bug.
  4. If possible, include any error messages or logs that may be relevant to the problem.

Showing support for ColaBOT

Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.

Don't have time to contribute? Don't worry, here are some other ways to show your support to ColaBOT:

  • ⭐ Star the project
  • ⭐ Rating and review the extension in the VSCode Marketplace
  • And above all, using it in your Visual Studio Code!