diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9d2e2cf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +I accept contributions via Pull Requests on [Github](https://github.com/MarinX/agemobile). + +## Pull Requests + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Create feature branches** - Don't ask us to pull from your master branch. + +## Running Tests + +```bash +$ go test +``` + +**Happy coding**! diff --git a/README.md b/README.md index 84f5da3..8c6665f 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ No examples, yet! PR's welcome. ## Contributing -PR's are welcome. Please read [CONTRIBUTING.md](https://github.com/MarinX/electrumrpc/blob/master/CONTRIBUTING.md) for more info +PR's are welcome. Please read [CONTRIBUTING.md](https://github.com/MarinX/agemobile/blob/master/CONTRIBUTING.md) for more info ## License