Skip to content

Commit

Permalink
docs: update CONTRIBUTING with note on using conventional commits
Browse files Browse the repository at this point in the history
  • Loading branch information
mefellows committed Feb 4, 2022
1 parent 9e0b860 commit a085a0c
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,29 @@

Contributions are very welcome, from beginners and experienced Pact users alike. Please chat to us in the `#documentation` channel of the Pact Foundation Slack workspace ([signup](https://slack.pact.io)|[login](https://pact-foundation.slack.com)) if you have any questions or suggestions, or raise an issue in the Github repository for bugs that you can't submit a PR for yourself.

### Commit messages

Pact uses the [Conventional Changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
commit message conventions. Please ensure you follow the guidelines, as they
help us automate our release process.

You can take a look at the git history (`git log`) to get the gist of it.
If you have questions, feel free to reach out in `#documentation` in our [slack
community](https://pact-foundation.slack.com/).

## A note about spelling

The pact documentation is written in British English, because it's good for
readability to standardise on spelling, and pragmatically
The pact documentation is written in British English, because it's good for
readability to standardise on spelling, and pragmatically
most of the core maintainers are in countries where the British English
spelling is the most common. Please don't adjust British to American spelling in your PR.

## Content updates

* Click on the `EDIT` link of the page you want to update.
* You will be prompted to create a fork. Please do so.
* Make your changes.
* Open a PR back to the `docs.pact.io` repository.
- Click on the `EDIT` link of the page you want to update.
- You will be prompted to create a fork. Please do so.
- Make your changes.
- Open a PR back to the `docs.pact.io` repository.

You can test our your changes locally if you have Docker Compose by cloning your fork and running `docker-compose up`.

Expand All @@ -25,12 +35,12 @@ For more significant changes, like adding pages or changing URLs, you will need
## Syncing docs from a new repository

1. Prepare development environment
1. Install Ruby 2.6 ish
1. Install the bundler gem `gem install bundler -v 2.0.2`
1. Install the gems `bundle install`
1. Install Ruby 2.6 ish
1. Install the bundler gem `gem install bundler -v 2.0.2`
1. Install the gems `bundle install`
1. Copy one of the sync scripts from [/scripts/sync](/scripts/sync) and modify it to sync from the desired repository to the desired path.
1. Run it by executing `bundle exec scripts/sync/your_new_script.rb`
1. Update [/website/sidebars.json](/website/sidebars.json) to include the new section and pages.
1. Update [.github/workflows/sync-docs.yml](.github/workflows/sync-docs.yml) with an event for the new repository.
1. In the source repository, copy [this workflow]((https://github.com/pact-foundation/pact-js/blob/master/.github/workflows/trigger_pact_docs_update.yml)) into the corresponding location.
1. In the source repository, copy [this workflow](<(https://github.com/pact-foundation/pact-js/blob/master/.github/workflows/trigger_pact_docs_update.yml)>) into the corresponding location.
1. If the source repository is in the `pact-foundation` organisation and you have permissions, modify the scope of the `GHTOKENFORTRIGGERINGPACTDOCSUPDATE` secret so that it can be used by the repo. Otherwise, ask @bethesque to do it.

0 comments on commit a085a0c

Please sign in to comment.