commit cb2b01c962c3c664963aabedd9b6773ebb8f02ec
parent 5638a5f0840e40af06e5356cd09c8639e5703379
Author: Ayush Agarwal <ayushnix@fastmail.com>
Date: Fri, 5 Aug 2022 00:51:55 +0530
docs: make CONTRIBUTING.md git forge neutral
Diffstat:
1 file changed, 19 insertions(+), 9 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,17 +1,27 @@
-If you're interested in contributing and making [tessen](https://github.com/ayushnix/tessen) better,
-please ensure that
+If you're interested in contributing and making [tessen][1] better, please ensure that
-- your bash code doesn't trigger errors or warnings from
- [shellcheck](https://github.com/koalaman/shellcheck)
+- you've opened a ticket or an issue if you think you've found a bug or opened a discussion if you
+ want to add a new feature
- if you've used `# shellcheck disable` in your bash code, there should be a very good reason for it
+- your bash code doesn't trigger errors or warnings from [shellcheck][2]
-- your bash code has been formatted using [shfmt](https://github.com/mvdan/sh) with the following
- settings
+ if you've used `# shellcheck disable`, there should be a compelling reason for it
+
+- your bash code has been formatted using [shfmt][3] with the following settings
`-s -i 2 -ci -sr -bn`
-Please raise an [issue](https://github.com/ayushnix/tessen/issues/new/choose) if you have any
-questions.
+Please raise a [ticket on SourceHut][4] or an issue on [Codeberg][5] or [GitHub][6] for reporting
+bugs. If you have any questions or other comments, [send an email on SourceHut][7] or [start a
+discussion on GitHub][8].
Thanks!
+
+[1]: https://sr.ht/~ayushnix/tessen
+[2]: https://github.com/koalaman/shellcheck
+[3]: https://github.com/mvdan/sh
+[4]: https://todo.sr.ht/~ayushnix/tessen
+[5]: https://codeberg.org/ayushnix/tessen/issues
+[6]: https://github.com/ayushnix/tessen/issues
+[7]: mailto:~ayushnix/tessen@lists.sr.ht
+[8]: https://github.com/ayushnix/tessen/discussions
