From 5a2738f66529ccb19b27de9c9914efc6a27d9e10 Mon Sep 17 00:00:00 2001 From: welpo Date: Wed, 22 Feb 2023 02:44:29 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20add=20Contributing=20gui?= =?UTF-8?q?delines?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ README.md | 8 ++++++++ 2 files changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..627b022 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to tabi + +Halló! + +Thanks for contributing to [tabi](https://github.com/welpo/tabi). Before implementing new features and changes, please [submit an issue](https://github.com/welpo/tabi/issues/new) so that we can discuss it. + +We welcome contributions in many forms, including: +- Bug reports +- Feature requests +- Code patches +- Documentation improvements +- UI/UX suggestions + +If you're not sure how to contribute or need help with something, please don't hesitate to reach out via the [issue tracker](https://github.com/welpo/tabi/issues) or [mail](mailto:hi@welpo.ooo?subject=[GitHub]%20tabi). + +## How to submit a pull request? + +- Follow the [GitHub flow](https://guides.github.com/introduction/flow/). +- Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/) +- Use [gitmoji](https://gitmoji.dev/) – it's fun! + +## Code of Conduct + +We expect all contributors to follow our [Code of Conduct](./CODE_OF_CONDUCT.md). Please be respectful and professional when interacting with other contributors. + +## License + +The code is available under the [MIT license](./LICENSE). + +Thank you for your contributions! diff --git a/README.md b/README.md index 7b753e9..4024a7b 100644 --- a/README.md +++ b/README.md @@ -35,3 +35,11 @@ This theme was inspired by: - [Alfonso García's site](https://alfoncode.com/) - [tale-zola](https://github.com/aaranxu/tale-zola) - [internetVin's blog](https://internetvin.ghost.io) + +## Contributing + +Please do! Take a look at the [Contributing Guidelines](/CONTRIBUTING.md) to learn more. + +## License + +The code is available under the [MIT license](./LICENSE).