Skip to content

Latest commit

 

History

History
161 lines (113 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

161 lines (113 loc) · 4.29 KB
Raw

Contributing

Contributions welcome, please raise a pull request.

If you want to help and want to get more familiar with the codebase, try starting with the "good for beginners" issues. Feel free to request more guidance in the issue comments.

Requirements

You will need a recent version of Node and npm installed. Check the .nvmrc for a recommended version:

$ node -v
v14.21.3
$ npm -v
v6.14.18

To install Node (with npm) locally on macOS, we recommend brew with nvm:

brew install nvm
nvm install

Project structure

$ ls
dist/        # The compiled and ready to distribute build artefacts.
screenshots/ # Gets outputted by the end to end tests when something goes wrong.
examples/    # GitHub pages examples of using the autocomplete.
scripts/     # Build scripts that don't fit in `package.json`.
src/         # The source code for the library.
test/        # The tests for the library.

Build tasks

To develop locally:

npm install
npm run dev

Contributions will need to pass the linter and tests. To run everything once:

npm test

To run the linter on its own:

npm run standard

To run the functional tests in dev mode (automatically reruns when a file changes):

npm run karma:dev

To run the integration tests locally with Chrome (specified in wdio.config.js):

npm run wdio

To run the integration tests on Sauce Labs, create a .env file with the following:

SAUCE_ENABLED="true"
SAUCE_USERNAME="XXXXXXXX"
SAUCE_ACCESS_KEY="YYYYYYYY"

And run the same command:

npm run wdio

Failed integration tests should output screenshots to the ./screenshots/ folder.

To build the project for distribution:

npm run build

You should do this and commit it before you attempt to git push, otherwise the prepush checks will prevent you from pushing.

Prepush checks

When you push to a branch, git will run a npm run prepush script that will compile the build on your behalf to the dist/ folder. If it then finds unstaged files in dist/, it will fail your push.

The solution is to commit the files, preferably as part of a separate commit:

npm run build
git add dist/
git commit -m "Rebuild dist"
git push

If you want to ignore the checks and push regardless:

git push --no-verify

PR nice to haves

  • Tests for your feature or fix
  • Updates to the README.md when necessary
  • A 1 line update in CHANGELOG.md describing your changes

Cutting a new release

git pull --rebase and then run:

git checkout -b "v1.2.3"
vim CHANGELOG.md # Update CHANGELOG, put all unreleased changes under new heading.
git commit -am "Update CHANGELOG"
npm version <major|minor|patch> -m "## 1.2.3 - 2017-01-13

- Change included in this release
- Another change included in this release"

Then run:

git push --tags --set-upstream origin refs/heads/v1.2.3:refs/heads/v1.2.3

Create a pull request for the release and merge once it has been approved, then run:

git checkout main
git pull --rebase

Publish the release

  1. Sign in to npm (npm login) as govuk-patterns-and-tools using the credentials from BitWarden.
  2. Run npm publish to publish to npm.
  3. Open the 'create a new release' dialog on GitHub.
  4. Select the latest tag version.
  5. Set 'v[VERSION-NUMBER]' as the title.
  6. Add the release notes from the changelog.
  7. Add a summary of highlights.
  8. Select Publish release.

You do not need to manually attach source code files to the release on GitHub.

Post a short summary of the release in the cross-government and GDS #govuk-design-system Slack channels. For example:

🚀 We’ve just released Accessible Autocomplete v2.0.1. You can now use the acccessible autocomplete multiple times on one page. Thanks to @ and @ for helping with this release. https://github.com/alphagov/accessible-autocomplete/releases/tag/v2.0.1