Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.86 KB
Raw

Contributing to ebtrfio-template

Thanks for your interest in contributing to ebtrfio-template! We welcome contributions from everyone, whether you're a beginner or an experienced developer. This guide outlines the process for contributing to our project.

Getting Started

To get started, follow these steps:

  1. Fork this repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes.

Making Changes

Once you have the repository set up, you can start making changes. We recommend following these guidelines when making contributions:

  • Follow the bash style guide when writing code.
  • Test your changes thoroughly before submitting a pull request.
  • If you're adding a new feature, include tests to ensure that it works as expected.
  • If you're fixing a bug, include a test that reproduces the bug and verifies that it has been fixed.
  • Ensure that your code complies with ShellCheck, a static analysis tool that detects common scripting issues.

Submitting a Pull Request

When you're ready to submit your changes, create a pull request by following these steps:

  1. Push your changes to the branch you created earlier.
  2. Go to the original repository and click the "New pull request" button.
  3. Select your forked repository and the branch containing your changes.
  4. Fill out the pull request template with a brief description of your changes and any relevant information.
  5. Submit the pull request.

Code of Conduct

We have adopted a Code of Conduct that we expect all contributors to follow. You can find it here.

Issues

If you encounter any issues while working on the project, please report them in the issue tracker.

License

This project is licensed under the MIT License.

Thanks for contributing!