Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 2.15 KB
Raw

Contributing

Thank you for contributing to ReactVancouver open source projects!

Choosing an issue

💡 TIP: Get feedback from the core maintainers and / or community before jumping into code.

If you do know what you want to contribute…

→ Create an issue using a template:

  • Feature: if you want to implement something new.
  • Bug: if you want to fix something broken.

If you don’t know what you want to contribute…

→ Look at the open issues. If you are just starting out, look for good first issue tags. Comment on the issue to discuss the implementation plan or reach out to core maintainers on Slack.

Setting Up

1. Get the code

You will need [email protected] and [email protected] installed globally on your machine

git clone https://github.com/React-Vancouver/website.git
cd website/
yarn

2. Create environment files

Add .env.production and .env.development file with your own keys.

$ mv .env.sample .env.production
$ mv .env.sample .env.development

Ask core maintainers for the keys 🔑.

3. Start Development Server

Gatsby

yarn start

Storybook

yarn storybook

Working on issues

  1. Create a new branch for your work: 1.1 off project branch if you are contributing to a larger project, 1.2 off production if you are contributing an individual feature or fix.
  2. The naming convention for branches is [feature|fix]/[issue-number]/[issue-name] (eg feature/3/add-readme)
git checkout -b feature/3/add-readme
yarn && yarn start

Pull Request Process

  1. Open a PR against a project or production branch depending on what you were working on.
  2. Get at least one review.
  3. You may merge the Pull Request in once you have the sign-off from a core maintainer (see CODEOWNERS).

If you were working on a project, the project branch will be merged into production when it is complete and ready for release.