diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2542ed5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +Any feedback / contribution are welcome. Just open an `issue`, a `PR` or start a `discussion`. + +## Code style / conventions + +- Try to write [clean, idiomatic Rust code](https://github.com/mre/idiomatic-rust). +- Keep code [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) whenever it makes sense. +- Before pushing any code make sure to run `clippy` and `fmt`. Check provided [`just`](./jusfile) file to run such commands, [CI](https://github.com/sectore/timr-tui/blob/main/.github/workflows/ci.yml) will do the same. +- Have fun to write code. + +## Design files + +Use [Figma Design file](https://www.figma.com/community/file/1553076532392275586/timr-tui) to suggest design changes + +## AI + +Always understand what AI provides to you. Never push any code based on [`vibe coding`](https://en.wikipedia.org/wiki/Vibe_coding) you or anybody else can't follow. Make sure your agent still follows all code styles and conventions suggested above. Use AI for better, not for worse code. diff --git a/README.md b/README.md index 2a9b546..3827ccb 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.or - [Installation](./#installation) - [Development](./#development) - [Misc](./#misc) +- [Contributing](./#contributing) - [License](./#license) # Preview @@ -303,6 +304,10 @@ C:/Users/{user}/AppData/Local/timr-tui/logs/app.log Optional: You can use a custom directory by passing it via `--log` arg. +# Contributing + +[CONTRIBUTING.md](./CONTRIBUTING.md) + # License [MIT License](./LICENSE)