-
Notifications
You must be signed in to change notification settings - Fork 361
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add contributing guide * fix: proper wording
- Loading branch information
1 parent
b471b4d
commit f13c6bb
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |