Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 4.53 KB

CONTRIBUTING.md

File metadata and controls

95 lines (59 loc) · 4.53 KB
Raw

Welcome to @deliberative/crypto contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on the project's GitHub homepage ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

To get started you need to have nodejs and emsdk installed on your machine and in your path. You also need to clone this repository and its submodule in order to be able to compile the library

git clone [email protected]:deliberative/crypto.git dcrypto
cd dcrypto
npm i
git submodule update --init --recursive

To check that everything works as expected you can run

npm run valgrind
npm test

Issues

Create a new issue

If you spot a problem with the code, search if an issue already exists. If a related issue doesn't exist, you can open a new issue by pasting the relevant output of your terminal.

Solve an issue

If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes in the tests

If you want to make changes to the tests, you need to make sure that they pass.

Make changes in the code

If you want to make changes to the code, you also need to write a corresponding test and make sure that it passes.

General procedure

  1. Fork the repository.
  • Using the command line:
    • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

  1. Install or update to Node.js v19 and emsdk v3.1.28 or later.

  2. Create a working branch and start with your changes!

  3. Run

npm run format && npm run lint

Commit your update

Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the Description form so that we can review your PR. This helps us understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The @deliberative team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible.