Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

69 lines (51 loc) · 3.06 KB
Raw

Contributing Guidelines

Thank you for considering contributing to this project! We welcome contributions from anyone, whether you are a beginner or an experienced developer.

Getting Started

To get started, follow these steps:

  • Fork the project repository
  • Clone the forked repository to your local machine
  • Create a new branch for your changes
  • Make your changes and test them thoroughly
  • Commit your changes and push them to your forked repository
  • Create a pull request to submit your changes for review

Guidelines

  • All contributions must be made via pull requests
  • Pull requests should include a clear and concise description of the changes being made
  • Code contributions must follow the project's coding standards and style guide
  • Contributions must not introduce new bugs or break existing functionality
  • Contributors should be respectful and considerate of others when commenting and reviewing code

Code of Conduct

By participating in this project, you are expected to uphold the project's Code of Conduct. Please read the CODE_OF_CONDUCT before contributing.

Coding Standards and Style Guide

We want to ensure that the codebase is maintainable, readable, and consistent across all contributions. We follow the Google Shell Style Guide for our bash scripts. Please make sure to follow the guide for all contributions.

Here are some additional guidelines to follow:

  • Use meaningful variable names and comments to make the code easy to understand.

  • Use functions to encapsulate reusable code blocks.

  • Use exit codes appropriately to signal success or failure of commands.

  • Before submitting a pull request, please ensure that your code passes our linting and formatting checks.

    You can run the checks locally by installing shellcheck and running:

    $ shellcheck your_script.sh

Commit Message Style Guide

When contributing to this project, please follow the guidelines below for your commit messages:

  • Use the imperative mood in your commit messages (e.g. "Fix bug" instead of "Fixed bug")
  • Keep the first line of your commit message under 50 characters
  • Use the body of the commit message to explain what and why you made the changes
  • Start the body with a blank line
  • Use bullet points to list any important changes or new features
  • Use the present tense when describing what the commit does (e.g. "Add feature" instead of "Added feature")
  • Use the past tense when describing what the commit did (e.g. "Fixed bug" instead of "Fix bug")

Here's an example of a good commit message:

- Updated dependency X to version Y
- Added error handling to function Z

And here's an example of a bad commit message:

Fixed app bug

Please take the time to write clear and informative commit messages, as they help everyone understand the changes made to the codebase.

Contact

If you have any questions or concerns about contributing to this project, please contact the project maintainer(s) at email address.

Thank you for contributing to our project!