Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 1.56 KB

Contribution Guidelines

When contributing to tunnelbear-vpn, whether on GitHub or in other community spaces:

  • Be respectful, civil, and open-minded.
  • Before opening a new pull request, try searching through the issue tracker for known issues or fixes.

How to Contribute

Prerequisites

In order to not waste your time implementing changes that has already been declined, or is generally not needed, start by opening an issue describing the problem you would like to solve.

Setup your environment

In order to contribute to this project, you need to do this steps:

  1. Fork this repository
  2. Clone the forked repository to you local machines:
git clone https://github.com/<your-github-name>/tunnelbear-vpn.git
  1. Install all the dependecies
npm install

Implement your changes

When making commits, make sure to follow the conventional commit guidelines, i.e. prepending the message with feat:, fix:, chore:, docs:, etc... You can use git status to double check which files have not yet been staged for commit:

git add <file>
git commit -m "feat/fix/chore/docs: commit message"

When you're done

Please a make PR to the upstream in the main branch.

Credits

This documented was inspired by the contributing guidelines for cloudflare/wrangler2.