Skip to content

Commit 40687db

Browse files
authored
Rewrite documentation
#971
2 parents afe1056 + e8e78d5 commit 40687db

27 files changed

+1015
-388
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
55
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the format is based on [Common Changelog](https://common-changelog.org).\
66
Unlike Common Changelog, the `unreleased` section of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) is preserved with the addition of a tag to specify which type of release should be published and to foster discussions about it inside pull requests. This tag should be one of the names mandated by SemVer, within brackets: `[patch]`, `[minor]` or `[major]`. For example: `## Unreleased [minor]`.
77

8-
## Unreleased
8+
## Unreleased [patch]
9+
10+
### Fixed
11+
12+
- Rewrite documentation to bring it up to date with current behaviour.
913

1014
## 0.17.0 - 2022-12-06
1115
### Added

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ First of all, thanks for taking the time to contribute! 🎉👍
1515
- [Practices](#practices)
1616
- [Errors handling](#errors-handling)
1717

18-
---
18+
- - -
1919

2020
## Workflow
2121

@@ -61,6 +61,15 @@ All changes to the codebase that impact users must be documented in the [`CHANGE
6161

6262
### Documentation
6363

64+
#### Copywriting
65+
66+
Avoid “you” and “we” (who is “we” in a common anyway?). Use neutral or passive wordings.
67+
68+
```diff
69+
- You can find federated public instances on GitHub.
70+
+ Federated public instances can be found on GitHub.
71+
```
72+
6473
#### CLI
6574

6675
##### docopt

README.fr.md

Lines changed: 0 additions & 110 deletions
This file was deleted.

0 commit comments

Comments
 (0)