Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 2.59 KB
Raw

Guidance on how to contribute

💡🎉 First off, thanks for taking the time to contribute! 🎉💡

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

The following is a set of guidelines for contributing to node-SaTT. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Issues

Issues are created here.

Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort.

When opening a new issue in the issue tracker, users will be presented with a template that should be filled in. If you believe that you have found a bug in node-satt, please fill out the template to the best of your ability.

Pull Requests

  1. Fork the project on GitHub: Help Guide to Fork a Repository.

  2. Clone the project: Help Guide to Clone a Repository

  3. Create a branch specific to the issue you are working on:

git checkout -b feature/AmazingFeature
  1. Commit your Changes using a descriptive commit message:
git commit -m 'Add some AmazingFeature'
  1. Push your commits to your GitHub Fork:
git push origin feature/AmazingFeature
  1. Open a Pull Request.

Within GitHub, visit this main repository and you should see a banner suggesting that you make a pull request. While you're writing up the pull request, you can add Closes #XXX in the message body where #XXX is the issue you're fixing. Therefore, an example would be Closes #56 would close issue #56.

Rewards

💰 Each profitable contribution will be rewarded 💰. It would be ideal if you create a Wallet and fill in the issue template with your Wallet adress or send it to us at [email protected].

Rewards will be decently conveyed concurring to the issue name prioritizing security issue. For each issue name we'll relegate focuses concurring the issue complexity (critical/high/medium/low) and the number of code lines included by each contributor except for security issue name the number of code lines will not be taken into account: The more serious the vulnerability identified is the more you will be compensated.

Further Reading

For more in-depth guides on developing node-SaTT, see docs.