docs: update contributing guide (#4)

crabisoft · Nov 9, 2023 · 70908ee · 70908ee
1 parent c1e211a
commit 70908ee
Show file tree

Hide file tree

Showing 3 changed files with 137 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,5 @@
 # CHANGELOG
 
-## v1.0.0 (2023-10-25)
+## v0.0.1 (2023-10-25)
 
 * Initial release
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -39,8 +39,140 @@ Please provide your patches as GitHub pull requests. Thanks!
 Commit message guidelines
 -------------------------
 
-We enforce commit messages to be formatted using the `conventional-changelog <https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit>`_.
-This leads to more readable messages that are easy to follow when looking through the project history.
+We enforce commit messages to be formatted using the `Conventional Commits <https://www.conventionalcommits.org/>`_.
+
+We have very precise rules over how our Git commit messages must be formatted.
+This format leads to **easier to read commit history**.
+
+Each commit message consists of a **header**, a **body**, and a **footer**.
+
+.. code-block:: text
+
+   <header>
+   <BLANK LINE>
+   <body>
+   <BLANK LINE>
+   <footer>
+
+
+The `header` is mandatory and must conform to the `Commit Message Header`_ format.
+
+The `body` is *optional* for all commits except for those of type "docs" for **main** branch only, else it is *optional*
+When the body is present it must be at least 20 characters long and must conform to the `Commit Message Body`_ format.
+
+The `footer` is optional. The `Commit Message Footer`_ format describes what the footer is used for and the structure it must have.
+
+
+Commit Message Header
+^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: text
+
+   <type>(<scope>): <short summary>
+   │       │             │
+   │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
+   │       │
+   │       └─⫸ Commit Scope: cli|io|report|store|packaging|changelog
+   │
+   └─⫸ Commit Type: build|ci|chore|doc|feat|fix|perf|refactor|test
+
+The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
+
+
+Type
+""""
+
+Must be one of the following:
+
+* **ci**: Changes to our CI configuration files and scripts (examples: GitHub actions)
+* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
+* **docs**: Documentation only changes
+* **feat**: A new feature
+* **fix**: A bug fix
+* **perf**: A code change that improves performance
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **test**: Adding missing tests or correcting existing tests
+
+
+Scope
+"""""
+
+The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).
+
+The following is the list of supported scopes:
+
+* `cli`
+* `io`
+* `report`
+* `store`
+* `templates`
+
+There are currently a few exceptions to the "use package name" rule:
+
+* `packaging`: used for changes that change the pyhton package layout in all of our packages, e.g. changes to bundles, etc.
+
+* `changelog`: used for updating the release notes in CHANGELOG.md or its associated template file
+
+Summary
+"""""""
+
+Use the summary field to provide a succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize the first letter
+* no dot (.) at the end
+
+
+Commit Message Body
+^^^^^^^^^^^^^^^^^^^
+
+Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes".
+
+Explain the motivation for the change in the commit message body. This commit message should explain _why_ you are making the change.
+You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.
+
+
+Commit Message Footer
+^^^^^^^^^^^^^^^^^^^^^
+
+The footer can contain information about breaking changes and deprecations and is also the place to reference GitHub issues, Jira tickets, and other PRs that this commit closes or is related to.
+For example:
+
+.. code-block:: text
+
+   BREAKING CHANGE: <breaking change summary>
+   <BLANK LINE>
+   <breaking change description + migration instructions>
+   <BLANK LINE>
+   <BLANK LINE>
+   Fixes #<issue number>
+
+or
+
+.. code-block:: text
+
+   DEPRECATED: <what is deprecated>
+   <BLANK LINE>
+   <deprecation description + recommended update path>
+   <BLANK LINE>
+   <BLANK LINE>
+   Closes #<pr number>
+
+Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions.
+
+Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.
+
+
+Revert commits
+^^^^^^^^^^^^^^
+
+If the commit reverts a previous commit, it should begin with ``revert:``, followed by the header of the reverted commit.
+
+The content of the commit message body should contain:
+
+- information about the SHA of the commit being reverted in the following format: `This reverts commit <SHA>`,
+- a clear description of the reason for reverting the commit message.
+
 
 Code-Style
 ----------

diff --git a/docs/source/api/io.rst b/docs/source/api/io.rst
@@ -18,8 +18,8 @@ pdbfile module
     :undoc-members:
     :show-inheritance:
 
-Module contents
----------------
+io module
+---------
 
 .. automodule:: pdbstore.io
     :members: