Skip to content

docs: Slight tweaks to contributing guidelines #133

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
merged 1 commit into from
Jun 27, 2024
Merged

docs: Slight tweaks to contributing guidelines #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 6 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ The checks we perform are the following:
* Ensure files don't contain merge conflict strings.
* Ensure files end with a single blank line.
* Ensure we only use Unix line endings.
* Ensure test files are correctly named.
* Trim trailing whitespace.
* Ensure we use [type-hinting][typing].
* Check for common mistakes in [reStructuredText][rest] in our documentation.
Expand Down Expand Up @@ -133,8 +132,6 @@ search for and install them. These are the ones we recommend:
* **Conventional Commits:** Adhere to the [Conventional Commits][conventional]
specification for commit messages.
* **Coverage Gutters:** Display test coverage in the editor.
* **GitLab Workflow:** Integrate GitLab issues, merge requests, and pipelines
into VS Code.
* **GitLens — Git supercharged:** Integrate some of the powerful features of
[GitKraken][kraken] into VS Code.
* **IntelliCode:** AI-assisted development features.
Expand Down Expand Up @@ -235,10 +232,6 @@ Consider adding the following snippets:
The line at 79 characters is to remind you of the maximum line length, and
the one at 72 characters is to remind you of the maximum line length for
comments and docstrings (see [PEP8][pep8]).
* To prevent VS Code from sending telemetry data off-site, add
```json
"redhat.telemetry.enabled": false,
```
* If you'd like the UI to preserve the scope that you're currently editing at
the top of the file as you scroll through it, you can add
```json
Expand Down Expand Up @@ -468,14 +461,14 @@ work into logical, working commits. Use the **Conventional Commits** extension
for VS Code (or something similar) to ensure your commit messages adhere to the
[Conventional Commits specification][conventional].

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

> **Note:** If you rebase a branch that's already been pushed to a remote,
> you'll wind up changing the history, which will require a force push with
> `git push origin +<branch-name>`. That is permissible (even encouraged), but
> if you've had one or more reviewers or collaborators working with you on the
> branch, *get their buy-in first* before doing a force push.
> you'll wind up changing the history, which will require a force push. That
> is permissible (even encouraged), but if you've had one or more reviewers or
> collaborators working with you on the branch, *get their buy-in first* before
> doing a force push.

### When Work is Complete

Expand Down
Loading