mirror of
https://github.com/libgit2/libgit2.git
synced 2026-01-25 02:56:17 +00:00
docs: reorganize documents
Our non-technical documents are currently floating around loosely in our project's root, making it harden than necessary to discover what one is searching for. We do have a "docs/" directory, though, which serves exactly that purpose of hosting documentation. Move our non-technical documentation into the "docs/" directory. Adjust all links to these documents.
This commit is contained in:
14
README.md
14
README.md
@@ -69,8 +69,8 @@ Quick Start
|
||||
2. Create the cmake build environment: `cmake ..`
|
||||
3. Build libgit2: `cmake --build .`
|
||||
|
||||
Trouble with these steps? Read `TROUBLESHOOTING.md`. More detailed build
|
||||
guidance is available below.
|
||||
Trouble with these steps? Read our (troubleshooting guide)[docs/troubleshooting.md].
|
||||
More detailed build guidance is available below.
|
||||
|
||||
Getting Help
|
||||
============
|
||||
@@ -170,12 +170,12 @@ require assistance coordinating this, simply have the worker threads call
|
||||
Threading
|
||||
=========
|
||||
|
||||
See [THREADING](THREADING.md) for information
|
||||
See [threading](docs/threading.md) for information
|
||||
|
||||
Conventions
|
||||
===========
|
||||
|
||||
See [CONVENTIONS](CONVENTIONS.md) for an overview of the external
|
||||
See [conventions](docs/conventions.md) for an overview of the external
|
||||
and internal API/coding conventions we use.
|
||||
|
||||
Building libgit2 - Using CMake
|
||||
@@ -364,10 +364,10 @@ We welcome new contributors! We have a number of issues marked as
|
||||
and
|
||||
["easy fix"](https://github.com/libgit2/libgit2/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22easy+fix%22)
|
||||
that are good places to jump in and get started. There's much more detailed
|
||||
information in our list of [outstanding projects](PROJECTS.md).
|
||||
information in our list of [outstanding projects](docs/projects.md).
|
||||
|
||||
Please be sure to check the [contribution guidelines](CONTRIBUTING.md) to
|
||||
understand our workflow, and the libgit2 [coding conventions](CONVENTIONS.md).
|
||||
Please be sure to check the [contribution guidelines](docs/contributing.md) to
|
||||
understand our workflow, and the libgit2 [coding conventions](docs/conventions.md).
|
||||
|
||||
License
|
||||
==================================
|
||||
|
||||
@@ -97,7 +97,7 @@ Before wrapping up a PR, you should be sure to:
|
||||
|
||||
* Write tests to cover any functional changes
|
||||
* Update documentation for any changed public APIs
|
||||
* Add to the [`CHANGELOG.md`](CHANGELOG.md) file describing any major changes
|
||||
* Add to the [`changelog.md`](changelog.md) file describing any major changes
|
||||
|
||||
## Unit Tests
|
||||
|
||||
@@ -168,10 +168,8 @@ function and type naming, code formatting, and testing.
|
||||
|
||||
We like to keep the source code consistent and easy to read. Maintaining
|
||||
this takes some discipline, but it's been more than worth it. Take a look
|
||||
at the [conventions
|
||||
file](https://github.com/libgit2/libgit2/blob/development/CONVENTIONS.md).
|
||||
at the [conventions file](conventions.md).
|
||||
|
||||
## Starter Projects
|
||||
|
||||
See our [projects
|
||||
list](https://github.com/libgit2/libgit2/blob/development/PROJECTS.md).
|
||||
See our [projects list](projects.md).
|
||||
@@ -10,8 +10,8 @@ ideas that no one is actively working on.
|
||||
|
||||
## Before You Start
|
||||
|
||||
Please start by reading the [README.md](README.md),
|
||||
[CONTRIBUTING.md](CONTRIBUTING.md), and [CONVENTIONS.md](CONVENTIONS.md)
|
||||
Please start by reading the [README.md](../README.md),
|
||||
[contributing.md](contributing.md), and [conventions.md](conventions.md)
|
||||
files before diving into one of these projects. Those explain our work
|
||||
flow and coding conventions to help ensure that your work will be easily
|
||||
integrated into libgit2.
|
||||
@@ -14,8 +14,8 @@ We aim to release once every six months. We start the process by opening an issu
|
||||
- [ ] Make a release candidate
|
||||
- [ ] Plug any final leaks
|
||||
- [ ] Fix any last-minute issues
|
||||
- [ ] Make sure CHANGELOG reflects everything worth discussing
|
||||
- [ ] Update the version in CHANGELOG and the header
|
||||
- [ ] Make sure changelog.md reflects everything worth discussing
|
||||
- [ ] Update the version in changelog.md and the header
|
||||
- [ ] Produce a release candidate
|
||||
- [ ] Tag
|
||||
- [ ] Create maint/v0.X
|
||||
@@ -25,12 +25,12 @@ We tag at least one release candidate. This RC must carry the new version in the
|
||||
|
||||
Preparing the first release candidate includes updating the version number of libgit2 to the new version number. To do so, a pull request shall be submitted that adjusts the version number in the following places:
|
||||
|
||||
- CHANGELOG.md
|
||||
- docs/changelog.md
|
||||
- include/git2/version.h
|
||||
|
||||
As soon as the pull request is merged, the merge commit shall be tagged with a lightweight tag.
|
||||
|
||||
The tagging happens via GitHub's "releases" tab which lets us attach release notes to a particular tag. In the description we include the changes in `CHANGELOG.md` between the last full release. Use the following as a base for the release notes
|
||||
The tagging happens via GitHub's "releases" tab which lets us attach release notes to a particular tag. In the description we include the changes in `docs/changelog.md` between the last full release. Use the following as a base for the release notes
|
||||
|
||||
This is the first release of the v0.X series, <codename>. The changelog follows.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user