Browse Source

Add Contributing guideline and TODO

pull/2/head
James Mills 1 year ago
parent
commit
c26f40d752
Signed by: prologic GPG Key ID: AC4C014F1440EBD6
  1. 5
      AUTHORS
  2. 13
      CONTRIBUTING.md
  3. 5
      README.md
  4. 17
      TODO.md

5
AUTHORS

@ -0,0 +1,5 @@
# Entries should be added alphabetically in the form:
# Name or Organization <email address>
# The email address is not required for organizations.
James Mills <prologic@shortcircuit.net.au>

13
CONTRIBUTING.md

@ -0,0 +1,13 @@
# Contributing
No preference. If you know how to use Github and have contributed to open source projects before then:
* File an issue
* Submit a pull request
* File an issue + Submit a pull request
* Use this project somewhere :)
Be sure to add yourself to the [AUTHORS](/AUTHORS)
file when you submit your PR(s). Every contribution counts no how big or small!
Thanks for using twtxt!

5
README.md

@ -54,15 +54,16 @@ Then visit: http://localhost:8000/
## Stargazers over time
[![Stargazers over time](https://starcharts.herokuapp.com/prologic/twtxt.svg)](https://starcharts.herokuapp.com/prologic/bitcask)
[![Stargazers over time](https://starcharts.herokuapp.com/prologic/twtxt.svg)](https://starcharts.herokuapp.com/prologic/twtxt)
## Support
Support the ongoing development of Bitcask!
Support the ongoing development of twtxt!
**Sponser**
- Become a [Sponsor](https://www.patreon.com/prologic)
- Contribute! See [TODO](/TODO.md)
## Contributors

17
TODO.md

@ -0,0 +1,17 @@
# TODO(s)
This is a list of things that have been _thought_ about that either fix
known limitations or issues with this software or add additional features.
None of these currently are active issues at the time of writin gthis document,
however if you'd like to contribute please either
[create an issue](https://github.com/prologic/twtxt/issues/new) to discuss the
details and/or submit a Pull Request.
In no particular order:
- [ ] IndieAuth support
- [ ] Account deletion
- [ ] Render links
- [ ] Render subset of Markdown
- [ ] Reset password
Loading…
Cancel
Save