Quickstart
The objective of this document is to provide new volunteers with a step-by-step guide to start contributing to the Admin Panel tool at Greenstand.
Last updated
Was this helpful?
The objective of this document is to provide new volunteers with a step-by-step guide to start contributing to the Admin Panel tool at Greenstand.
Last updated
Was this helpful?
You will need to set up your Integrated Development Environment (IDE) to start contributing. At Greenstand, we recommend using Visual Studio Code (VSCode) as your IDE.
to download and install the latest version of VSCode for your OS.
Install extension for VSCode. Projects come with a .prettierrc config file that enforces code format standards and avoids styling issues among developers.
We are currently using Node version 16 to develop our projects. You can manage node versions installed on your machine by using Node Version Manager (nvm).
Download the nvm install script via cURL:
Ensure that nvm was installed correctly with nvm --version, which should return the version of nvm installed.
Run npm install to download project dependencies.
Find an issue you are interested in.
Once you've found something you are interested in, comment on the issue requesting to be assigned to it:
I would like to work on this issue!
Once you are assigned the issue, follow the git workflow below to contribute.
Before you start to code, make sure your local and forked repos are up to date with Greenstand's upstream repo.
Change to master branch: git checkout master
Sync local repo with upstream: git pull upstream master --rebase
Push upstream commits to fork: git push origin master
Start working on your issue by creating a new feature branch:
Create new feature branch: git checkout -b 'your-branch-name'
Commit your changes as you go along to make sure you don't lose them:
Add changes to staging: git add .
Create commit: git commit -m 'commit message here'
We enforce conventional commit message standard that follow the pattern [scope]: description, for example feat: add species filter.
Commits will fail if commit messages do not follow this pattern. Other available scopes are: fix:, feat:, build:, chore:, docs:, style:, refactor:, perf:, test:, ci:
Once you're happy with your changes, sync with Greenstand's upstream repo before pushing your commits:
Change to master branch: git checkout master
Sync local repo with upstream: git pull upstream master --rebase
Push upstream commits to fork: git push origin master
Change to your feature branch: git checkout 'your-feature-branch'
Apply upstream commits: git rebase master
Resolve any possible conflicts with upstream commits
Push feature branch to fork: git push origin 'your-feature-branch'
In your pull request comments, add a link to the issue you worked on:
Resolves #123
Code reviewers will review your pull request and either merge it to Greenstand's repo or request changes.
Congratulations! You just made your first contribution to Greenstand!
Create a .
on your local machine.
the repo.
to your local machine.
to your local cloned repo.
Run nvm install at the root directory of treetracker-admin-client to install the current version of Node supported by the project (this checks for the version).
Different Node version might cause unexpected problems. Please ensure that you are running the version of Node in in the project root.
Browse and for something to work on.
.
If changes are requested, follow the same workflow in this section using the already created feature branch. After pushing commits to your fork, GitHub will automatically update the pull request to reflect your changes. Ask a reviewer to .