Skip to content

Commit

Permalink
feat: add contributing guide (#107)
Browse files Browse the repository at this point in the history
* feat: add contributing guide

* fix: proper wording
  • Loading branch information
SputNikPlop authored Nov 21, 2023
1 parent b471b4d commit f13c6bb
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 @@
# Contributing

Thanks for helping make the go-blueprint better!
- [Contributing](#contributing)
- [Design Principles](#design-principles)
- [Report an Issue](#report-an-issue)
- [Contributing Code with Pull Requests](#contributing-code-with-pull-requests)
- [Requirements](#requirements)
- [Licensing](#licensing)

## Design Principles

Contributions to the go-blueprint should align with the project’s design principles:

* Maintain backwards compatibility whenever possible.

## Report an Issue

If you have run into a bug or want to discuss a new feature, please [file an issue](https://github.com/Melkeydev/go-blueprint/issues).

## Contributing Code with Pull Requests

go-blueprint uses [Github pull requests](https://github.com/Melkeydev/go-blueprint/pulls). Feel free to fork, hack away at your changes and submit.

### Requirements

* All commands and functionality should be documented appropriately
* All new functionality/features should have appropriate unit testing

go-blueprint strives to have a consistent set of documentation that matches the command structure and any new functionality must have accompanying documentation in the PR.

## Licensing

See the [LICENSE](https://github.com/melkeydev/go-blueprint/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

0 comments on commit f13c6bb

Please sign in to comment.