diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index c43a67b..115f299 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,8 +1,23 @@ # CONTRIBUTE -This file is not completed yet and still under devlopement +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. -## Steps to work on the project +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Code of Conduct + +See the code of conduct [here](./CODE_OF_CONDUCT.md) + +## Pull Request Process + +1. Update the README.md with details of changes to the extension. +2. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## Setup the project ``` node: 18.13.0 @@ -15,13 +30,13 @@ npm: 8.19.2 $ npm install ``` -## 2. Setup Git hooks +### 2. Setup Git hooks ``` $ git config --local core.hooksPath .githooks/ ``` -## 3. Build project +### 3. Build project ``` $ npm run build