Skip to content
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

Mention options for correcting formatting issues when taking the "Quick fix" approach to contributing #3587

Merged
merged 2 commits into from
Nov 22, 2023
Merged

Mention options for correcting formatting issues when taking the "Quick fix" approach to contributing #3587

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91db7c1
Mention options for correcting formatting issues when taking the "Qui…
swar8080 Nov 22, 2023
b0e3ada
Merge branch 'main' into swar8080-contributing-quick-fix-formatting
cartermp Nov 22, 2023
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 @@ -76,7 +76,16 @@ For small changes to a single file, you can edit directly in GitHub by clicking
**Edit this file** button. After forking the repository, follow the instructions
in [Editing files][].

For everything else, follow the
However, formatting may still be needed, like reducing line lengths in the
edited file. The options for fixing formatting are:

- Checking out the project and running the CLI scripts mentioned in
[Submitting a change](#submitting-a-change).
- Commenting `/fix:format` on your pull request to trigger an automated script.
This requires a unique branch name, which can be edited under _View all
branches_ in your fork.

Comment on lines +84 to +87
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add this in for now, but eventually I want to fix the automation script: we know what the problem is (if the branch name is used upstream as well the script gets "confused") and what the solution is (set the remote for the commit accordingly to the fork)

For larger fixes, follow the
[instructions to setup a development environment](#development) below.

### PR Guidelines
Expand Down Expand Up @@ -212,8 +221,8 @@ The website is built from the following content:

### Submitting a change

Before submitting a to the repository, run the following command and address any
reported issues. Also commit any files changed by the `fix` script:
Before submitting a change to the repository, run the following command and
address any reported issues. Also commit any files changed by the `fix` script:

```sh
npm run test-and-fix
Expand Down