mirror of
https://github.com/nikoksr/notify.git
synced 2024-11-24 08:22:18 +02:00
29 lines
1.0 KiB
Markdown
29 lines
1.0 KiB
Markdown
|
# Contributing to notify
|
||
|
|
We want to make contributing to this project as easy and transparent as
|
||
|
|
possible.
|
||
|
|
|
||
|
|
# Project structure
|
||
|
|
|
||
|
|
- `service` - Contains definitions for the underlying notification services.
|
||
|
|
- `service/discord` - Discord notification service.
|
||
|
|
- `service/mail` - Email notification service.
|
||
|
|
- `service/pseudo` - Pseudo notification service used internally to simulate a working service.
|
||
|
|
- `service/telegram` - Telegram notification service
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
We actively welcome your pull requests.
|
||
|
|
|
||
|
|
1. Fork the repo and create your branch from `main`.
|
||
|
|
2. If you've added code that should be tested, add tests.
|
||
|
|
3. If you've changed APIs, update the documentation.
|
||
|
|
4. Ensure the test suite passes.
|
||
|
|
5. Make sure your code lints.
|
||
|
|
|
||
|
|
## Issues
|
||
|
|
We use GitHub issues to track public bugs. Please ensure your description is
|
||
|
|
clear and has sufficient instructions to be able to reproduce the issue.
|
||
|
|
|
||
|
|
## License
|
||
|
|
By contributing to notify, you agree that your contributions will be licensed
|
||
|
|
under the LICENSE file in the root directory of this source tree.
|