Skip to content

Commit

Permalink
readme: change contributing subsection headings to bold
Browse files Browse the repository at this point in the history
  • Loading branch information
alonswartz authored and a3s7p committed May 23, 2022
1 parent 426ac11 commit 111f849
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,6 @@ This repository is for the Wireleap relay.
- [Versioning](#versioning)
- [Building](#building)
- [Contributing](#contributing)
- [Fork, clone and setup upstream remote](#fork-clone-and-setup-upstream-remote)
- [Create a feature branch and make your changes](#create-a-feature-branch-and-make-your-changes)
- [Unit testing](#unit-testing)
- [Rebase on master if needed](#rebase-on-master-if-needed)
- [Push changes and submit a pull request](#push-changes-and-submit-a-pull-request)
- [Review process and merge](#review-process-and-merge)
- [License](#license)

## Installation
Expand Down Expand Up @@ -589,7 +583,7 @@ A note about the `master` branch:

[github_flow]: https://guides.github.com/introduction/flow/

### Fork, clone and setup upstream remote
**Fork, clone and setup upstream remote**

The following instructions outline the recommended procedure for
creating a fork of this repository in order to contribute changes.
Expand All @@ -607,7 +601,7 @@ git pull --tags upstream master
git config commit.gpgsign true
```

### Create a feature branch and make your changes
**Create a feature branch and make your changes**

Create a descriptively named topic branch based on the `master` branch.
Please take care to only address **one** issue/bug/feature per pull
Expand All @@ -627,7 +621,7 @@ commits should be clear.
If a commit resolves a known issue or relates to other commits or PRs,
please refer to them.

### Unit testing
**Unit testing**

The unit tests can either be run on your host or within docker using the
official golang docker image.
Expand All @@ -644,7 +638,7 @@ mkdir -p build/.deps
DEPS_CACHE=build/.deps ./contrib/docker/run-tests.sh
```

### Rebase on master if needed
**Rebase on master if needed**

It can happen that as you were working on a feature, the state of the
`upstream/master` branch has changed due to merging other pull requests.
Expand All @@ -661,7 +655,7 @@ git rebase --interactive master DESCRIPTIVE_BRANCH_NAME
After every change to the git history of your topic branch, perform
testing to avoid regressions.

### Push changes and submit a pull request
**Push changes and submit a pull request**

When you think the topic branch is ready for merging, passes all tests,
all changes are committed with appropriate commit messages, and your
Expand All @@ -685,7 +679,7 @@ Finally, click `create pull request` so the reviewers can review and
approve the changes, or request modifications prior to performing the
merge.

### Review process and merge
**Review process and merge**

The pull request may be approved or additional modifications might be
requested by one of the reviewers. If modifications are requested,
Expand Down

0 comments on commit 111f849

Please sign in to comment.