Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 1.84 KB

Contributing to BICEP-COLORIZE-PR

Firstly, thank you for your interest in contributing to BICEP-COLORIZE-PR! 🎉 Every contribution, no matter how small, is valuable and appreciated.

Code of Conduct

By participating in this project, you're expected to uphold our Code of Conduct.

How to Contribute

  1. Fork the Repository: Start by forking the main repository, so you have your own copy to work on.
  2. Clone Your Fork: Clone your forked repository to your local machine. Use git clone <repository_url>.
  3. Create a New Branch: Before making any changes, create a new branch using git checkout -b branch-name.
  4. Make Changes: Make the necessary changes and ensure that your code adheres to the project's coding standards.
  5. Commit and Push: Once done, commit your changes using git commit -m "Your descriptive commit message", and then push using git push origin branch-name.
  6. Create a Pull Request: Go to the GitHub page of your forked repository and click on "Create Pull Request".

Pull Request Guidelines

  • PRs should be made from a branch, not the main branch of your fork.
  • PR titles should be descriptive and concise.
  • In the PR description, please provide a detailed explanation of the changes and the motivation behind them.
  • If the PR addresses an open issue, link it in the description.
  • Ensure that your PR has passed all CI checks before requesting a review.

Issues and Bug Reports

If you find a bug or have an enhancement suggestion, please create an issue first, detailing the bug or the use-case for the feature request.

Documentation

If you're adding new functionality, ensure that it's properly documented to make it accessible for other contributors.

Feedback and Questions

If you have feedback or questions, please open an issue, and we'll be happy to assist!