docs/_includes/contribute_code.md

Sections in this article

{:.no_toc}

• TOC {:toc}

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding guidelines used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

When contributing to Blockstack's documentation, you should edit the documentation source files in the /app/ directory of the master branch.

Adhering to the following process is the best way to get your work included in the project:

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/blockstack-browser.git
   # Navigate to the newly cloned directory
   cd blockstack-browser
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/blockstack/blockstack-browser.git
   

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master
   

3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

   git checkout -b <topic-branch-name>
   

4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream master
   

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>
   

7. Open a Pull Request with a clear title and description against the master branch.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MPL-2.0 License (if it includes code changes) and under the terms of the Creative Commons Attribution 3.0 Unported License (if it includes documentation changes).

Code guidelines

HTML

Adhere to the Code Guide.

• Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).

JS

• No semicolons (in client-side JS)
• 2 spaces (no tabs)
• strict mode
• "Attractive"
• Don't use jQuery (no "$" allowed)

Checking code

Run npm run dev before committing to ensure your changes follow our coding standards.

License

By contributing your code, you agree to license your contribution under the MPL-2.0 License.