From 04018c95ea0ccbd5e096066fb0b851e779802938 Mon Sep 17 00:00:00 2001 From: Gregory Rocco Date: Mon, 8 Mar 2021 13:18:32 -0500 Subject: [PATCH 1/2] added contribution guidelines --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..95f7ac54 --- /dev/null +++ b/CONTRIBUTING.md @@ -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) \ No newline at end of file From 01cdf925f3b9f115b1a6c5f185743e9db2ae1090 Mon Sep 17 00:00:00 2001 From: Gregory Rocco Date: Wed, 10 Mar 2021 16:31:42 -0500 Subject: [PATCH 2/2] updated shield --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 110b5a6d..a3211b15 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![OpenMinter header](/docs/assets/minterhead.png) -[![](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE) [![](https://img.shields.io/badge/Docker-20.10.x-blue)](https://www.docker.com/) [![](https://img.shields.io/badge/version-v0.2.1-orange)](https://github.com/tqtezos/minter) +[![](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE) [![](https://img.shields.io/badge/Docker-20.10.x-blue)](https://www.docker.com/) [![](https://img.shields.io/badge/version-v0.3.0-orange)](https://github.com/tqtezos/minter) ## Notice