@make-software/ces-js-parser
Version:
Parser for contract-level events encoded with Casper Event Standard (CES)
46 lines (34 loc) • 2.26 kB
Markdown
# Contributing to CES JS Parser
The following is a set of rules and guidelines for contributing to this repo. Please feel free to propose changes to this document in a pull request.
## Submitting issues
If you have questions about how to use CES JS Parser, please direct these to the related discord channels:
* [#smart-contracts](https://discord.gg/casperblockchain)
* [#sdk-development](https://discord.gg/casperblockchain)
### Guidelines
* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
- Go to the main page of the repository, click "issues" and type any word in the top search/command bar.
- You can also filter by appending e. g. "state:open" to the search string.
- More info on [search syntax within GitHub](https://help.github.com/articles/searching-issues)
## Contributing to CES JS Parser
All contributions to this repository are considered to be licensed under Apache License 2.0.
Workflow for bug fixes:
* Check open issues and unmerged pull requests to make sure the topic is not already covered elsewhere
* Fork the repository
* Do your changes on your fork
* Make sure to add or update relevant test cases
* Create a pull request, with a suitable title and description, referring to the related issue
### Sign your work
We use the Developer Certificate of Origin (DCO) as a additional safeguard
for the CES JS Parser project. This is a well established and widely used
mechanism to assure contributors have confirmed their right to license
their contribution under the project's license.
Please read [developer-certificate-of-origin](https://github.com/make-software/ces-js-parser/blob/master/.github/developer-certificate-of-origin).
If you can certify it, then just add a line to every git commit message:
````
Signed-off-by: Random J Developer <random@developer.example.org>
````
Use your real name (sorry, no pseudonyms or anonymous contributions).
If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
like `git config --global alias.ci 'commit -s'`. Now you can commit with
`git ci` and the commit will be signed.