Skip to content
This repository has been archived by the owner on Apr 25, 2024. It is now read-only.

Latest commit

 

History

History
86 lines (55 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

86 lines (55 loc) · 1.81 KB
Raw

Contributing

Contributions are always welcome, no matter how large or small.

Working on your first Pull Request? You can learn how from this free course How to Contribute to an Open Source Project on GitHub

Project setup

First, fork and then clone the caravan repository:

git clone https://github.com/your-username/caravan
cd caravan
git remote add upstream https://github.com/unchained-capital/caravan

Install dependencies:

npm install

Starting caravan locally (this will open caravan in your default browser):

npm run start

Creating Pull Requests

  1. Create a branch:
git checkout -b my-branch

  1. Happy Hacking 🎉: Author your awesome code changes.

  2. Ensure your changes pass linting and testing:

To test:

npm test

To lint your changes:

npm run lint
  1. Commit your changes:

caravan uses commitizen to create commit messages so it can automatically create semantic releases.

git add .
npm run commit
# answer the questions
  1. Push your changes:
git push origin my-branch
  1. Open this project on GitHub, then click “Compare & pull request”.

Releasing Caravan

Caravan is released to GitHub Pages (https://unchained-capital.github.io/) by using the following:

npm run release
git push --follow-tags origin master

Then go to GitHub and create a release in the UI. This will trigger a build and deployment to GitHub pages.

Help needed

Please checkout the open issues for ideas of things to work on.

Also, please watch the repo and respond to questions/bug reports/feature requests, Thanks!