Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 4.82 KB

CONTRIBUTING.md

File metadata and controls

108 lines (66 loc) · 4.82 KB
Raw

Contributing to seek-style-guide

⚠️ 🌏 👀 First and foremost, remember that this repo is open source.

Don't post anything or commit any code that isn't ready for the entire world to see. If you're introducing new patterns, try to keep it abstract, rather than making specific reference to the features under development. While a lot of this information is probably harmless, it's better to be safe than sorry.

If you work at SEEK and run into issues along the way, or even if you find some of these steps confusing or intimidating, please reach out to your friendly neighbourhood developer in the living style guide Slack channel. We'll be super excited to help out!

Setup

First, install Node.js.

After cloning the project, install the dependencies:

$ npm install

Before Starting

If you're planning to change the public API, please open a new issue and follow the provided RFC template. If you think it's a more straightforward API change and doesn't require a formal RFC, feel free to raise it in Slack first to see what others think.

Workflow

Before starting your work, first ensure you're in the master branch and that you've pulled down the latest changes:

$ git checkout master
$ git pull

Next, create a new branch for your work, with an appropriate name for your change:

$ git checkout -b add-my-cool-new-feature

In order to see changes to the style guide during development, run the local development server:

$ npm start

To run the test suite locally:

$ npm test

Note that the test suite needs to pass for your changes to be accepted, so it's worth running this locally during development and before committing.

Even though we'd like to automate as much as possible, a comprehensive manual test is never a bad idea, especially if you're working in an area of the codebase that's particularly business critical. Reviewers are also encouraged to put UI changes through their paces, to act as a last line of defense before merging.

Formatting

Code format is controlled by Prettier.

To format your code:

$ npm run format

To confirm your code is formatted correctly:

$ npm run lint-format

Note: The npm run lint command will automatically run npm run lint-format.

Committing

Once you've made the desired changes and you're ready to commit, first stage your local changes:

$ git add .

Before continuing, consider the scope of your changes according to semantic versioning, noting whether this is a breaking change, a feature release or a patch.

New versions are published automatically from Travis CI using semantic-release. In order to automatically increment version numbers correctly, commit messages must follow the conventional commit message format. If your commit includes a breaking change, be sure to prefix your commit body with BREAKING CHANGE:. To make this process easier, we have a commit script (powered by commitizen) to help guide you through the commit process:

$ npm run commit

Once you've committed your work, push your changes to a branch of the same name on GitHub:

$ git push --set-upstream origin $(git symbolic-ref --short HEAD)

Next, head over to the style guide's GitHub page and create a new pull request from your branch. You'll be presented with a pull request template, which provides separate outlines for major, minor, patch and non-release branches. Please follow this guide carefully, but raise any questions and concerns along the way if anything is unclear.

In order for your pull request to be accepted, the Travis CI build needs to pass, and 2 other contributors needs to approve your work. GitHub will block your PR until you have your first approval, but make sure you wait for a second approval. It's likely that you might need to make some changes for your work to be accepted, but don't take this personally! Ultimately, the aim is to make it feel like the codebase was written by a single person, but this takes a lot of work and constant review of each others' work.

Merging

Once your work is approved and ready to go, follow these steps:

  1. Hit the merge button
  2. Ensure the commit message matches the title of the PR (it may have been edited!)
  3. Copy and paste the text under "Commit Message For Review" into the commit body (again, it may have been edited!)

Finally, take a deep breath, hit the green "confirm" button, and we have liftoff—your work should be automatically deployed!

🎨📦🚀