git.iko.soy/streamly
on master help sign in
Rephrase some sentences now that the README is moved
d0117d7Adithya Kumar
CONTRIBUTING.md+2−2
compare with master
unifiedsplit
@@ -90,8 +90,8 @@ Here is a quick checklist for a PR, for details please see the next section:
90* [Performance benchmarks](benchmark) are added, where applicable
90* [Performance benchmarks](benchmark) are added, where applicable
91* No significant regressions are reported by [performance benchmarks](benchmark/README.md)
91* No significant regressions are reported by [performance benchmarks](benchmark/README.md)
92* Haddock documentation is added to user visible APIs and data types
92* Haddock documentation is added to user visible APIs and data types
93−* Tutorial module, [README](docs/Introduction.md), and [guides](docs) are updated if
93+* Tutorial module, [Introduction](docs/Introduction.md), and [guides](docs) are
94− necessary.
94+ updated if necessary.
95* [Changelog](docs/Changelog.md) is updated if needed
95* [Changelog](docs/Changelog.md) is updated if needed
96* The code conforms to the license, it is not stolen, credit is given,
96* The code conforms to the license, it is not stolen, credit is given,
97 copyright notices are retained, original license is included if needed.
97 copyright notices are retained, original license is included if needed.
dev/MAINTAINING.md+5−4
@@ -31,8 +31,8 @@
31
31
32* _Documentation_:
32* _Documentation_:
33
33
34− * README is updated.
34+ * Documentation is updated.
35− * Check if all the links in the README are stable.
35+ * Check if all the links in the docs are stable.
36 * External links might point to the `master` branch of a few
36 * External links might point to the `master` branch of a few
37 repositories. Pin them to a specific version that works with the current
37 repositories. Pin them to a specific version that works with the current
38 release.
38 release.
@@ -98,7 +98,7 @@
98
98
99* _Update Package Metadata:_
99* _Update Package Metadata:_
100
100
101− * Make sure the description in cabal file is in sync with README and other docs
101+ * Make sure the description in cabal file is in sync with the docs
102 * Make sure CI configs include last three major releases of GHC in CI testing.
102 * Make sure CI configs include last three major releases of GHC in CI testing.
103 * Update GHC `tested-with` field
103 * Update GHC `tested-with` field
104 * Update `docs/building.md` with the distributions tested with
104 * Update `docs/building.md` with the distributions tested with
@@ -140,7 +140,8 @@
140
140
141 * Create a git tag corresponding to the release where X.Y.Z is the new
141 * Create a git tag corresponding to the release where X.Y.Z is the new
142 package version (`git tag vX.Y.Z && git push -f origin vX.Y.Z`).
142 package version (`git tag vX.Y.Z && git push -f origin vX.Y.Z`).
143− * Mask out the build status lines from the README
143+ * Mask out the build status lines from the
144+ [docs/Introduction.md](docs/Introduction.md)
144 * Upload to hackage
145 * Upload to hackage
145 * Use a clean workspace to create source distribution
146 * Use a clean workspace to create source distribution
146 by freshly cloning the git repository. The reason for
147 by freshly cloning the git repository. The reason for