Add contributing information

This commit is contained in:
DJ Chase 2024-01-18 17:48:12 -05:00
parent c8f30dac49
commit 592f9bb905
2 changed files with 41 additions and 0 deletions

8
AUTHORS.md Normal file
View File

@ -0,0 +1,8 @@
# Authors
<!--
including your email or website is optional,
but it does allow people to contact you
-->
- [DJ Chase](https://dj-chase.com/)

33
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,33 @@
# Contributing
I normally use [Sourcehut][1] for my projects, which is based on the
[`git send-email`][2] workflow. I intend to make Sourcehut the primary repo once
its done recoving from the DDoS attack (Ill keep this mirror up though), so
most work on this project currently uses Sourcehut infrastructure. The Tildegit
repo is basically just so people can clone it.
[1]: https://sourcehut.org/
[2]: https://git-send-email.io/
## Normal contributing stuff
All contributions are welomed. If you can, please try to follow the format
below. If you cant, just send an email to ~u9000/vtt-embed@lists.sr.ht asking
me to pull from your remote (remember to include the URL of your remote), or
just send an email.
1. `git pull`
2. contribute
3. add your name to AUTHORS
4. commit
5. `git send-email --to='~u9000/vtt-embed@lists.sr.ht' HEAD^` (or `HEAD~n` for
the last *n* commits)
## Issues
To make the future transition easier,
[issues are already hosted on Sourcehut][3]. Before raising an issue, please
[email the mailing list][4] first to discuss.
[3]: https://todo.sr.ht/~u9000/vtt-embed
[4]: https://lists.sr.ht/~u9000/vtt-embed