-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix format issues in markdown files (#1332)
Currently, when Markdown Linting is run, there are some minor format issues in markdown files. Checked all markdown files and fixed all relevant issues in them.
- Loading branch information
1 parent
f533d30
commit 0ab5a99
Showing
6 changed files
with
19 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,6 +37,7 @@ please raise an issue so that we can clarify this document. | |
|
||
> [!WARNING] | ||
> Don't use | ||
> | ||
> ```bash | ||
> git clone [email protected]:TraceMachina/nativelink | ||
> ``` | ||
|
@@ -199,23 +200,22 @@ NativeLink doesn't allow direct commits or human-created side branches in the | |
git push --set-upstream origin some-feature | ||
``` | ||
|
||
6. Go to https://github.com/TraceMachina/nativelink/pulls where you should see a | ||
5. Go to https://github.com/TraceMachina/nativelink/pulls where you should see a | ||
button that you can click to create to create a new pull request from your | ||
fork to the main repository. | ||
|
||
7. Once you opened the pull request, click on the purple `Reviewable` button in | ||
6. Once you opened the pull request, click on the purple `Reviewable` button in | ||
the GitHub page for the pull request to add reviewers with `+@somereviewer`. | ||
|
||
The reviewers will take it from there and guide you through any potential | ||
remaining issues. Feel free to ask for help if you have trouble getting CI | ||
for your pull request green. | ||
|
||
8. If you need to make additional changes, don't use a regular `git commit` on | ||
7. If you need to make additional changes, don't use a regular `git commit` on | ||
the pull request branch. Instead use `git commit --amend` and `git push -f` | ||
to update the commit in-place. The changes between the commit versions will | ||
remain visible in the Reviewable UI. | ||
|
||
|
||
### Using `git rebase` | ||
|
||
When you start working on a feature your `git log` looks something like this: | ||
|
@@ -394,7 +394,7 @@ NativeLink implements its documentation style guide via Vale. The pre-commit | |
hooks forbid errors but permit warnings and suggestions. To view all of Vale's | ||
suggestions invoke it directly: | ||
|
||
``` | ||
```bash | ||
vale somefile | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters