git.iko.soy/streamly
on master help sign in
Rephrase some sentences now that the README is moved
commitd0117d7049e1dc576da7e84e607cbed57661e43f authorAdithya Kumar <adithya@composewell.com> dateTue 8 Feb 2022, 00:47 (5 years ago) parent4cfedba
2 files changed+7−6
compare with master
unifiedsplit
CONTRIBUTING.md+2−2 dev/MAINTAINING.md+5−4
CONTRIBUTING.md+2−2
@@ -90,8 +90,8 @@ Here is a quick checklist for a PR, for details please see the next section:
9090* [Performance benchmarks](benchmark) are added, where applicable
9191* No significant regressions are reported by [performance benchmarks](benchmark/README.md)
9292* Haddock documentation is added to user visible APIs and data types
93−* Tutorial module, [README](docs/Introduction.md), and [guides](docs) are updated if
94− necessary.
93+* Tutorial module, [Introduction](docs/Introduction.md), and [guides](docs) are
94+ updated if necessary.
9595* [Changelog](docs/Changelog.md) is updated if needed
9696* The code conforms to the license, it is not stolen, credit is given,
9797 copyright notices are retained, original license is included if needed.
dev/MAINTAINING.md+5−4
@@ -31,8 +31,8 @@
3131
3232* _Documentation_:
3333
34− * README is updated.
35− * Check if all the links in the README are stable.
34+ * Documentation is updated.
35+ * Check if all the links in the docs are stable.
3636 * External links might point to the `master` branch of a few
3737 repositories. Pin them to a specific version that works with the current
3838 release.
@@ -98,7 +98,7 @@
9898
9999* _Update Package Metadata:_
100100
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
102102 * Make sure CI configs include last three major releases of GHC in CI testing.
103103 * Update GHC `tested-with` field
104104 * Update `docs/building.md` with the distributions tested with
@@ -140,7 +140,8 @@
140140
141141 * Create a git tag corresponding to the release where X.Y.Z is the new
142142 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)
144145 * Upload to hackage
145146 * Use a clean workspace to create source distribution
146147 by freshly cloning the git repository. The reason for