this repo has no description
Merge pull request #25520 from kit-ty-kate/fix-279
Fix a couple of typos in CONTRIBUTING.md
authored by
Marcello Seri
and committed by
GitHub
7563ab7b
38988760
+4
-4
+4
-4
CONTRIBUTING.md
+4
-4
CONTRIBUTING.md
···
17
17
18
18
There are several ways to add a new package to opam-repository.
19
19
You can either use a tool such as `dune-release` or `opam-publish`, or open a PR manually.
20
-
Each ones have their strenghts and weaknesses. For example:
20
+
Each ones have their strengths and weaknesses. For example:
21
21
* `dune-release` is a tool more focused into helping people do their whole release process from start to finish for them. To that end it:
22
22
* helps with tagging
23
23
* parses (and enforces a format, can be good or bad) for the changelog, to put it in the tag
···
143
143
If, as an external contributor, you are willing to help out, you can send a PR to fix the packages that are broken. This is extremely helpful.
144
144
145
145
There are several types of fixes:
146
-
* **Changes to the metadata** (e.g. `homepage`, `synopsis`, …) are simple, usualy harmless and easy to do and get merged.
146
+
* **Changes to the metadata** (e.g. `homepage`, `synopsis`, …) are simple, usually harmless and easy to do and get merged.
147
147
* **Changes to the dependencies or availibility** require some scrutiny from the opam-repository maintainers to verify that the new constraints are correct and do not break existing working installations.
148
148
* **Changes to the way the package is built** (e.g. changes to the build rules, addition of patches, …) require a lot more scrutiny from the opam-repository maintainers and maybe a new revision.
149
149
* **Changes to the source archive(s)** is prohibited but in the case where there is no other choice and the checksum is not the same, the difference with the original must be negligable.
···
155
155
#### Revisions
156
156
157
157
Revision versions are packages whose version is of the form `<version>-<revision>` with the revision number typically starting at 1.
158
-
They typically privide a slightly modified version of an original release.
158
+
They typically provide a slightly modified version of an original release.
159
159
160
-
For example `pkg.1.0.0` is not maintained anymore (be it this specific version or the package as a whole), and someone would like to privide a patch to fix something that some people might rely on even if it might be a buggy behivour. In this case the package is duplicated into the original version (left untouched) and the revision with the fix. This way, if the fix broke someone's setup they case still use the original version.
160
+
For example `pkg.1.0.0` is not maintained anymore (be it this specific version or the package as a whole), and someone would like to provide a patch to fix something that some people might rely on even if it might be a buggy behaviour. In this case the package is duplicated into the original version (left untouched) and the revision with the fix. This way, if the fix broke someone's setup they case still use the original version.
161
161
162
162
#### Patches
163
163