Skip to content

Commit d2f569e

Browse files
authored
Merge pull request #133 from sandialabs/tweak-contributing-guidelines
docs: Slight tweaks to contributing guidelines
2 parents 3c673f4 + 6e2ddc9 commit d2f569e

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ The checks we perform are the following:
7777
* Ensure files don't contain merge conflict strings.
7878
* Ensure files end with a single blank line.
7979
* Ensure we only use Unix line endings.
80-
* Ensure test files are correctly named.
8180
* Trim trailing whitespace.
8281
* Ensure we use [type-hinting][typing].
8382
* Check for common mistakes in [reStructuredText][rest] in our documentation.
@@ -133,8 +132,6 @@ search for and install them. These are the ones we recommend:
133132
* **Conventional Commits:** Adhere to the [Conventional Commits][conventional]
134133
specification for commit messages.
135134
* **Coverage Gutters:** Display test coverage in the editor.
136-
* **GitLab Workflow:** Integrate GitLab issues, merge requests, and pipelines
137-
into VS Code.
138135
* **GitLens — Git supercharged:** Integrate some of the powerful features of
139136
[GitKraken][kraken] into VS Code.
140137
* **IntelliCode:** AI-assisted development features.
@@ -235,10 +232,6 @@ Consider adding the following snippets:
235232
The line at 79 characters is to remind you of the maximum line length, and
236233
the one at 72 characters is to remind you of the maximum line length for
237234
comments and docstrings (see [PEP8][pep8]).
238-
* To prevent VS Code from sending telemetry data off-site, add
239-
```json
240-
"redhat.telemetry.enabled": false,
241-
```
242235
* If you'd like the UI to preserve the scope that you're currently editing at
243236
the top of the file as you scroll through it, you can add
244237
```json
@@ -468,14 +461,14 @@ work into logical, working commits. Use the **Conventional Commits** extension
468461
for VS Code (or something similar) to ensure your commit messages adhere to the
469462
[Conventional Commits specification][conventional].
470463

471-
Feel free to commit and push small chunks early and often and then use `git
472-
rebase -i` to reorganize your commits before sharing.
464+
Feel free to commit and push small chunks early and often and then use
465+
interactive rebase to reorganize your commits before sharing.
473466

474467
> **Note:** If you rebase a branch that's already been pushed to a remote,
475-
> you'll wind up changing the history, which will require a force push with
476-
> `git push origin +<branch-name>`. That is permissible (even encouraged), but
477-
> if you've had one or more reviewers or collaborators working with you on the
478-
> branch, *get their buy-in first* before doing a force push.
468+
> you'll wind up changing the history, which will require a force push. That
469+
> is permissible (even encouraged), but if you've had one or more reviewers or
470+
> collaborators working with you on the branch, *get their buy-in first* before
471+
> doing a force push.
479472
480473
### When Work is Complete
481474

0 commit comments

Comments
 (0)