Skip to content

Commit

Permalink
📄 Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Searge authored Apr 13, 2024
1 parent 6cb0841 commit 322a956
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# How to Contribute to This Project

## Did You Find a Bug?

- **Ensure the bug was not already reported** by searching on GitHub under
[Issues][issues].
- If you're unable to find an open issue addressing the problem,
[open a new one][new-issue]. Be sure to include a **title and clear
description**, as much relevant information as possible, and a **code
sample** or an **executable test case** demonstrating the expected
behavior that is not occurring.

## Did You Write a Patch That Fixes a Bug?

- Open a new GitHub pull request with the patch.
- Fork this project
- Create your feature branch: `git checkout -b my-new-feature`
- Commit your changes: `git commit -am 'Add some feature'`
- Push to the branch: `git push origin my-new-feature`
- Submit a pull request :tada:
- Ensure the PR description clearly describes the problem and solution.
Include the relevant issue number if applicable.

## Do You Intend to Add a New Feature or Change an Existing One?

- Suggest your change as a [new issue][new-issue] using the label
`enhancement`, **BEFORE** you start writing code.

Thanks for contributing! :heart:

[//]: # (Simply change the URLs below to your project information)

[issues]: https://github.com/Searge/k8s-hard-way-ansible/issues
[new-issue]: https://github.com/Searge/k8s-hard-way-ansible/issues/new

0 comments on commit 322a956

Please sign in to comment.