Skip to content

add additional guidance for contributing #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexroan merged 2 commits into from
May 28, 2021
Merged

add additional guidance for contributing #111

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e12b81
add additional guidance for contributing
StephenFluin May 26, 2021
4a94718
Merge branch 'main' into stephen/update-contrib
alexroan May 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ PRs are welcome! We try to keep a clean commit history, so we'll follow a standa
* Someone will review your PR
* Your PR will be merged, amended, closed, or you'll be asked for changes

## Standards
* Commit messages
* Start with a present tense verb
* Keep your commit headline short but sufficient to understand the scope and focus of the change.
* Changes are often formatted like `add doc X`, `fix page Y`, `improve docs for Z`.
* Example: "`update contract addresses for BSC`".
* If you touch any infrastructure, make sure it builds with `yarn build`
* Trust the autoformatter (prettier)
* Make sure images are optimized and compressed
* Keep images < 20kb whenever possible to keep the site fast and the repo small

## How to rebase a PR
```shell
git fetch
Expand Down Expand Up @@ -37,7 +48,7 @@ squash 3eccd39 fix typos

### 2. Fix your commit message

Next, comment or remove all of your commit messages and leave the one that describes your PR: `add doc X`, `fix page Y`, `improve docs for Z`. For example: `add contract addresses for X blockchain`.
Next, comment or remove all of your commit messages and leave the one that describes your PR.

### 3. Force push to your branch

Expand All @@ -51,5 +62,3 @@ Here's a [complete example](https://twitter.com/stephenfluin/status/100990409507

It's easier to use `git --amend` while working on your PR first. Avoiding multiple commits is much cleaner and easier than fixing them.

## Other Standards
* Trust the autoformatter (prettier)