docs: Update Contributing and tutorial pages
This commit is contained in:
parent
90b1644f1e
commit
6ca312a923
|
|
@ -1,5 +1,14 @@
|
||||||
Submitting patches
|
---
|
||||||
------------------
|
nav_order: 19
|
||||||
|
---
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
{: .no_toc }
|
||||||
|
|
||||||
|
1. TOC
|
||||||
|
{:toc}
|
||||||
|
|
||||||
|
## Submitting patches
|
||||||
|
|
||||||
A majority of current maintainers prefer the GitHub pull request
|
A majority of current maintainers prefer the GitHub pull request
|
||||||
model, and this motivated moving the primary git repository to
|
model, and this motivated moving the primary git repository to
|
||||||
|
|
@ -26,8 +35,7 @@ Alternative methods if you don't like GitHub (also fully supported):
|
||||||
It is likely however once a patch is ready to apply a maintainer
|
It is likely however once a patch is ready to apply a maintainer
|
||||||
will push it to a GitHub PR, and merge via Homu.
|
will push it to a GitHub PR, and merge via Homu.
|
||||||
|
|
||||||
Commit message style
|
## Commit message style
|
||||||
--------------------
|
|
||||||
|
|
||||||
Please look at `git log` and match the commit log style, which is very
|
Please look at `git log` and match the commit log style, which is very
|
||||||
similar to the
|
similar to the
|
||||||
|
|
@ -66,15 +74,13 @@ For more information see [How to Write a Git Commit Message](https://chris.beams
|
||||||
|
|
||||||
To edit the message from the most recent commit run `git commit --amend`. To change older commits on the branch use `git rebase -i`. For a successful rebase have the branch track `upstream master`. Once the changes have been made and saved, run `git push --force origin <branch-name>`.
|
To edit the message from the most recent commit run `git commit --amend`. To change older commits on the branch use `git rebase -i`. For a successful rebase have the branch track `upstream master`. Once the changes have been made and saved, run `git push --force origin <branch-name>`.
|
||||||
|
|
||||||
Running the test suite
|
## Running the test suite
|
||||||
----------------------
|
|
||||||
|
|
||||||
OSTree uses both `make check` and supports the
|
OSTree uses both `make check` and supports the
|
||||||
[Installed Tests](https://wiki.gnome.org/GnomeGoals/InstalledTests)
|
[Installed Tests](https://wiki.gnome.org/GnomeGoals/InstalledTests)
|
||||||
model as well (if `--enable-installed-tests` is provided).
|
model as well (if `--enable-installed-tests` is provided).
|
||||||
|
|
||||||
Coding style
|
## Coding style
|
||||||
------------
|
|
||||||
|
|
||||||
Indentation is GNU. Files should start with the appropriate mode lines.
|
Indentation is GNU. Files should start with the appropriate mode lines.
|
||||||
|
|
||||||
|
|
@ -168,7 +174,6 @@ Instead do this:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
Contributing Tutorial
|
## Contributing Tutorial
|
||||||
---------------------
|
|
||||||
|
|
||||||
For a detailed walk-through on building, modifying, and testing, see this [tutorial on how to start contributing to OSTree](contributing-tutorial.md).
|
For a detailed walk-through on building, modifying, and testing, see this [tutorial on how to start contributing to OSTree](contributing-tutorial.md).
|
||||||
|
|
|
||||||
|
|
@ -1,21 +1,14 @@
|
||||||
|
---
|
||||||
|
nav_order: 20
|
||||||
|
---
|
||||||
|
|
||||||
# OSTree Contributing Tutorial
|
# OSTree Contributing Tutorial
|
||||||
|
{: .no_toc }
|
||||||
|
|
||||||
The following guide is about OSTree forking, building, adding a command, testing the command, and submitting the change.
|
The following guide is about OSTree forking, building, adding a command, testing the command, and submitting the change.
|
||||||
|
|
||||||
- [Getting Started](#getting-started)
|
1. TOC
|
||||||
- [Building OSTree](#building-ostree)
|
{:toc}
|
||||||
- [Install Build Dependencies](#install-build-dependencies)
|
|
||||||
- [OSTree Build Commands](#ostree-build-commands)
|
|
||||||
- [Testing a Build](#testing-a-build)
|
|
||||||
- [Testing in a Container](#testing-in-a-container)
|
|
||||||
- [Testing in a Virtual Machine](#testing-in-a-virtual-machine)
|
|
||||||
- [Tutorial: Adding a basic builtin command to OSTree](#tutorial-adding-a-basic-builtin-command-to-ostree)
|
|
||||||
- [Modifying OSTree](#modifying-ostree)
|
|
||||||
- [OSTree Tests](#ostree-tests)
|
|
||||||
- [Submitting a Patch](#submitting-a-patch)
|
|
||||||
- [Returning Workflow](#returning-workflow)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue