This repository has been archived by the owner on Jul 31, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #234 from tqtezos/v0.3.0-2
v0.3.0 (2)
- Loading branch information
Showing
2 changed files
with
50 additions
and
1 deletion.
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,49 @@ | ||
# Contributing to OpenMinter | ||
We welcome all feedback on OpenMinter, and we wish to | ||
make contributing as easy as possible for interested | ||
participants. These contributions can include but aren't | ||
limited to: | ||
|
||
- Reporting a bug | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
- Proposing new features | ||
|
||
## We Develop with Github | ||
We use GitHub to host code, to track issues and feature | ||
requests, as well as accept pull requests. | ||
|
||
## All Code Changes Happen Through Pull Requests | ||
Pull requests are the best way to propose changes to the codebase. | ||
|
||
1. Fork the repo and create your branch from `main`. | ||
2. If you've added code that should be tested, add tests. | ||
3. If you've changed anything major, update the documentation. | ||
4. Ensure the test suite passes and your code lints. | ||
6. Open the PR, specifically targeting our `develop` branch. | ||
|
||
## All contributions adhere to our MIT License | ||
All code changes will be subject to the same [MIT License](http://choosealicense.com/licenses/mit/) that currently covers the project. Make sure | ||
to keep this in mind when submitting any changes. | ||
|
||
## Report bugs using [issues](https://github.com/tqtezos/minter/issues) | ||
We use GitHub issues to track bugs and manage how they're addressed. | ||
Please make sure to open a new issue when reporting a bug, or search | ||
existing issues to see if the bug has alreqady been reported. | ||
|
||
Please be sure to report your issues with detail, background, and sample | ||
code if applicable. The more associated detail, the easier it is to address. | ||
|
||
Be sure to include: | ||
- A quick summary | ||
- Your current build environment | ||
- Steps to reproduce | ||
- What you expected to happen | ||
- What actually happened | ||
- Notes | ||
|
||
## License | ||
By contributing, you agree that your contributions will be licensed under its MIT License. | ||
|
||
## References | ||
This document was adapted from the contribution guidelines from [Transcriptase](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62) |
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