Skip to content

Commit 1f05c7a

Browse files
Fixed a typo and adapted text as per community feedback
1 parent 64c5ac2 commit 1f05c7a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

projects/guidelines.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Any software library should strive to the following:
2727
Avoid pre-existing trademarks for software products or services.
2828
* **Licensing.** An open-source license should be attached to the software.
2929
* **Installation.** Instructions for how to install the library should be trivial to find, and the installation procedure should be standard for (e.g., at least via pip if the programming language is Python).
30-
* **Documentation.** The code should be suitable documented and a users guide (at least in the format of a “quick start”) should be highlighted. For small libraries a users guide may be provided in the repository README.
30+
* **Documentation.** The code should be suitably documented and a users guide (at least in the format of a “quick start”) should be highlighted. For small libraries a users guide may be provided in the repository README.
3131
* **Test suite.** Code should always be (comprehensively) tested. Test coverage is strongly encouraged and should be displayed on the repository for a straightforward verification of the level of testing implemented.
3232
* **Open to contributors.** The repository should encourage contributions from the community and should never disable pull/merge requests on the developer platform (such as GitHub).
3333
* **Issue tracking.** Each library repository provides an issue (bug, wish) tracker for users and developers to interact, allowing anonymous view of both open and closed tickets.
@@ -100,7 +100,8 @@ obtain, provide feedback (as bug reports or enhancements), and contribute to the
100100

101101
* The project's source repository MUST track what changes were made, who made the changes, and when the changes were made.
102102
* To enable collaborative review, the project's source repository SHOULD include interim versions for review between releases; it SHOULD NOT include only final releases.
103-
* The project results MUST have a unique version identifier for each release intended to be used by users. It is recommended to use Semantic Versioning.
103+
* The project results MUST have a unique version identifier for each release intended to be used by users.
104+
We recommend to use either [Semantic Versioning](https://semver.org) or [Calendar Versioning](https://calver.org/) as appropriate, since popular schemes.
104105
* The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be.
105106
The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes).
106107

0 commit comments

Comments
 (0)