Contributing to PulseNet documentation
If you choose to contribute to the PulseNet you will help in building a quick and secured decentralised exchange for our digital asset.
The idea is to make it as easy as possible for you to contribute changes that will help the PulseNet Chain to expand and thrive. However, to do this, we will require you to follow some guidelines, this will ensure that we are able to merge your changes quickly.
To begin with
- Create a GitHub account if you haven’t already got one
- Using GitHub, create an “issue” for your contribution, please assume that one does not already exist.
- Describe in detail the issue, please include the steps required to reproduce this, if it is a bug.
- Using GitHub please now “Fork” the repository.
For minor Changes
Documentation
If you wish to make small changes to the comments and documentation, you are not always required to create a new GitHub issue. Instead you can, if appropriate, start the first line of a commit with ‘doc’ instead of an issue number.
Finding things to work on
You should begin by looking over the current GitHub issues for the project you wish to contribute too. Issues that have been marked with [help wanted][help-wanted] are likely self-contained and therefore would be a good place to get started.
However should you think there is something that needs to be added or fixed, create a new issue.
To Make Changes
- Create a topic branch, this is from where you would like to base your work.
- This is referred to as master branch.
- Avoid working on the master branch itself.
- Ensure that you have provided the testing process for your changes, you have successfully completed those tests and that they did indeed pass.