Skip to content

Commit a2a67eb

Browse files
authored
Restructuring and Updating CONTRIBUTING.md (#312)
Alines with the terms from the README.md (e.g. CSL-JSON Schema or add csl-categories.rnc). Also makes explicit a section about issues (with the text which was already there) and moved this together with PR on the top. The rules for versioning are much less frequent and therefore following, but also renamed from their previous title.
1 parent 4b7e60c commit a2a67eb

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
# How to Contribute
22

3-
## Schema Changes
3+
## Pull Requests
4+
5+
We encourage pull requests. Please use the following guidelines:
6+
7+
- in general, follow [these recommendations](https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/) on writing good commit messages
8+
- make sure your PRs are focused, and link where possible to existing issues
9+
- follow the instructions on the PR template
10+
11+
## Issues
12+
13+
Regardless of the change, however, the current status of CSL requires us to be fairly conservative. For issue reports, please follow the template instructions, and include all specified information. It's important for us to be able to quickly understand what you are requesting, how broad the need is, and what implementation options there are.
14+
15+
## Versioning
416

5-
### RELAX NG Style Language
17+
### Changes to the CSL Schema
618

719
At this point, changes to the CSL RELAX NG schema consist of the following:
820

921
<dl>
10-
<dt>Changes to csl-terms.rnc, csl-types.rnc, or csl-variables.rnc</dt>
22+
<dt>Changes to csl-categories.rnc, csl-terms.rnc, csl-types.rnc, or csl-variables.rnc</dt>
1123
<dd>Adding new variables, item types, locators, or terms; these can usually be added to minor x.x.x version changes.</dd>
1224
<dt>Changes to csl.rnc</dt>
1325
<dd>These are often more significant and may have an impact on compatability, and so are typically reserved for major x.x version changes.</dd>
1426
</dl>
1527

16-
Regardless of the change, however, the current status of CSL requires us to be fairly conservative. For issue reports, please follow the template instructions, and include all specified information. It's important for us to be able to quickly understand what you are requesting, how broad the need is, and what implementation options there are.
17-
18-
### JSON Data Schemas
19-
20-
The data schemas are intended to mirror the rnc files, and so follow similar conventions. Ideally when we add variables, we add to both at the same time.
21-
22-
## Pull Requests
28+
### Changes to the CSL-JSON Schema
2329

24-
We encourage pull requests. Please use the following guidelines:
25-
26-
- in general, follow [these recommendations](https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/) on writing good commit messages
27-
- make sure your PRs are focused, and link where possible to existing issues
28-
- follow the instructions on the PR template
30+
The data schemas are intended to mirror the `rnc` files, and so follow similar conventions. Ideally when we add variables, we add to both at the same time.
2931

3032
## Pre-Commit Hooks
3133

0 commit comments

Comments
 (0)