Skip to content

Commit

Permalink
pm: minimal documentation requirements
Browse files Browse the repository at this point in the history
Not going into a lot of details yet, leaving #3 for the future.

Signed-off-by: Roman Khimov <[email protected]>
  • Loading branch information
roman-khimov committed Feb 1, 2024
1 parent d828fbe commit 145bb70
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions project-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,18 @@ issues get a set of corresponding PR/commit links automatically and nothing
special is required. However if an issue is closed manually, there MUST be
a comment describing how and where it's fixed or why it shouldn't/can't be
fixed.

## Documentation

Each project MUST have a README file describing with brief introduction and
minimal instructions on how to use it for what purposes.

Each project that has releases MUST have a release instruction in its documents.

Each project with releases MUST have a CHANGELOG describing changes between
them. This CHANGELOG MUST describe configuration changes if any.

Each project MUST have a LICENSE file with license for its contents.

If project has any runtime dependencies on other projects, there has to be a
table with compatible versions of this project and its dependencies.

0 comments on commit 145bb70

Please sign in to comment.