diff --git a/CHANGELOG.md b/CHANGELOG.md index 84427ef..7f957f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,8 +8,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] + +### Changed - Broaden the Solidity version pragma to ^0.4.21 - Set cache of shield.io badges to 1h +- Use master/devel branch instead of master +- Cleanup CONTRIBUTING.md ### Added - [README]: EIP badge with link to the official EIP diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 932683d..f668d9e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ To optimize this process and increase the chances of accepting your suggestion, 1. Make sure it is lint properly with: - `npm run lint:js` for javascript - - `npm run lint:sol` for solidity + - `npm run lint:sol` for solidity > Use `npm run lint` to lint both javascript and solidity 2. Provide tests for your code and ensure they run and pass with `npm run test`. 3. Make sure you don't break anything: @@ -28,18 +28,18 @@ To optimize this process and increase the chances of accepting your suggestion, 4. Keep things clean and organized: - Solidity code must be in `/contracts` - Tests must be in `/test` -5. Write a [good commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html): +5. Write a [good commit messages]: - Capitalized, short (50 chars or less) summary - Optionally, one blank line followed by a more detailed explanation 6. Document your changes in `CHANGELOG.md` under the [Unreleased section](CHANGELOG.md#Unreleased). -7. Submitted your changes via [a pull request (PR)](https://github.com/jacquesd/ERC777/pulls) from your fork of the repository and detail the changes in the description. -8. Make sure your pull request is up to date with [master](https://github.com/jacquesd/ERC777/commits/master). +7. Submitted your changes via [a pull request (PR)][pull request] from your fork of the repository against the [devel] branch and detail the changes in the description. +8. Make sure your pull request is up to date with [devel]. ## What should I do if.... ### I have a suggestion but I can't implement it. -If you have a suggestion, but can't modify the reference implementation either because of lack of time or because you are unsure about how exactly to implement it, [open an issue](https://github.com/jacquesd/ERC777/issues). Try to explain your suggestion as clearly as possible and if you can, provide example scenarios. +If you have a suggestion, but can't modify the reference implementation either because of lack of time or because you are unsure about how exactly to implement it, [open an issue][issue]. Try to explain your suggestion as clearly as possible and if you can, provide example scenarios. ### I have a suggestion and code to go with it. @@ -48,9 +48,9 @@ Feel free to submit a pull request from a branch of your fork of the repository, ### I don't have a suggestion but I found a bug or inconsistency. -Good catch! First [open an issue](https://github.com/jacquesd/ERC777/issues) explaining the bug and **provide a proof of concept (PoC)**. +Good catch! First [open an issue][issue] explaining the bug and **provide a proof of concept (PoC)**. -Then if you are able to, indicate in the issue that you have a fix on the way and provide a [pull request](https://github.com/jacquesd/ERC777/pulls). +Then if you are able to, indicate in the issue that you have a fix on the way and provide a [pull request]. ### I don't have a suggestion and I didn't find a bug but I want to help. @@ -58,6 +58,11 @@ Thanks for your help! If there is an [open issue](https://github.com/jacquesd/ERC777/issues?q=is%3Aopen+is%3Aissue) not assigned to anyone which you feel you can solve, indicate your interest and once assigned it's yours to fix! -At that point simply provide a [pull request](https://github.com/jacquesd/ERC777/pulls). +At that point simply provide a [pull request]. >Note: If you have a PR for an open issue which is not assigned to you, feel free to submit it too. But please understand that someone else may already be working on a fix and your PR may be refused. + +[devel]: https://github.com/jacquesd/ERC777/commits/devel +[pull request]: https://github.com/jacquesd/ERC777/pulls +[issue]: https://github.com/jacquesd/ERC777/issues +[good commit messages]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html