Skip to content

Latest commit

 

History

History
121 lines (89 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

121 lines (89 loc) · 3.89 KB
Raw

Contributing to CryptoCaddy

Contributions to CryptoCaddy could come in different forms. Some contribute code changes, some provide relevant tax and accounting information, while others contribute docs etc.

We welcome all contributions from folks who are willing to work in good faith with the community. No contribution is too small and all contributions are valued.

Issues

Issues in CryptoCaddy/web-app are the primary means by which bug reports and general discussions are made.

Discussions And General Help

Go to our slack for the most recent project information and for more in depth discussion or help.

Pull Requests

Pull Requests are the way in which concrete changes are made to the code and documentation.

Step 1: Fork

Fork the project on GitHub and clone your fork locally.

Once forked, follow these instructions to clone your forked branch.

$ git clone [email protected]:username/web-app.git
$ cd web-app
$ git remote add upstream https://github.com/cryptocaddy/web-app.git
$ git fetch upstream

Step 2: Branch

It's always better to create local branches to work on a specific issue. Makes life easier for you if you are the kind who enjoys multiple things parallely. These should also be created directly off of the master branch.

$ git checkout -b my-branch -t upstream/development

Step 3: Code

As of now, we don't have any sort of design style / lint to validate things. So we ask you to ensure all these are met before you shoot out a PR.

  • Avoid trailing whitespace & un-necessary white lines
  • Indentation is as follows
    • 1 tab = 2 spaces for .html files
    • 1 tab = 4 spaces for everything else
    • Linters will be added to make this easier.

Step 4: Commit

  1. List all your changes as a list if needed else simply give a brief description on what the changes

  2. All lines at 100 columns.

  3. If your PR fixed an issue, Use the Fixes: prefix and the full issue URL. For other references use Refs:.

    Examples:

    • Fixes: https://github.com/cryptocaddy/web-app/issues/1
    • Refs: https://github.com/cryptocaddy/web-app/issues/1

  4. Sample commit A

    if you can write down the changes explaining it in a paragraph which each
line wrapped within 30 lines.

Fixes: https://github.com/cryptocaddy/web-app/issues/1
Refs: https://github.com/cryptocaddy/web-app/issues/1

    Sample commit B

    - list out your changes as points if there are many changes
- all wrapped within 30 lines

Fixes: https://github.com/cryptocaddy/web-app/issues/1
Refs: https://github.com/cryptocaddy/web-app/issues/1

  5. Squashing and Merging your commits to make our history neater is always welcomed.

Step 5: Rebase

Ensure you neat description on what your PR is for, so that it's easier for folks to understand the gist of it without before jumping to the the code / doc.

As a best practice, once you have committed your changes, it is a good idea to use git rebase (not git merge) to ensure your changes are placed at the top. Plus merge conflicts can be resolved

$ git fetch upstream
$ git rebase upstream/development

Code of Conduct

CryptoCaddy Code of Conduct.

Acknowledgement

The Gitcoin contributing file was used as a template for this file.