Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 2.44 KB

How to contribute

I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.

If you haven't already, come find us in Slack (Dether Slack. We want you working on things you're excited about.

Here are some important resources:

Testing

We are testing the smart contracts with Javascript in async/await style, and the Truffle framework to run them. Please write test examples for new code you create.

Submitting changes

Please send a GitHub Pull Request to Dether with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include tests. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Commit guidelines

git checkout -b feature/...
git checkout -b fix/...
[ADD] new file/function/feature
[UPD] update file/function/feature
[UPG] upgrade dependency
[ARC] refactor part of the project
[DEL] remove file/function/feature
[WIP] work in progress
git checkout develop
git merge origin feature/...
git merge origin fix/...

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m “[???] A brief summary of the commit
>
> A paragraph describing what changed and its impact.”

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

  • We indent using two spaces (soft tabs)
  • We use async/await for tests