diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e4f3d92 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +To contribute: +1. Fork the repo or create a branch prefixed with a valid [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) qualifier (e.g. `feat/cool-new-thing` or `fix/write-code-code`) +2. Add commits to your branch following the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) standard. A github action will run to validate your commits before merge, so ***you will not be bale to merge if you do not use conventional commits.*** +3. Add test coverage for your feature/fix/improvement. +3. Make a PR for your changes and get 1 review/approval +4. Merge your changes! \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..a4e5a77 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +This is a fun toy project for a personal home dashboard meant to both be useful and as some Rust practice. Planned features: +1. Backlog tracking for games/movies/tv shows/books and a "now playing/reading/etc" (fancy spreadsheet) +2. Automatic planning of run/cycling routes based on a training schedule each morning +3. Getting the Nasa Astronomy Pictre of the Day/current xckd/wikipedia home page/etc or any other fun stuff +4. Plugin system for any other pieces that someone may want to use! \ No newline at end of file