go/notify
1
0
Fork 0
mirror of https://github.com/nikoksr/notify.git synced 2025-01-03 22:52:23 +02:00
Code Issues Releases Activity

docs(contrib): update contribution guidelines

Browse Source
This commit is contained in:
Niko Köser 2021-01-31 15:02:45 +01:00
parent c2e2e5e40d
commit 9e82322aa0
No known key found for this signature in database
GPG Key ID: F3F28C118DAA6375
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -1,23 +1,33 @@
# Contributing to notify
## Contributing to notify
We want to make contributing to this project as easy and transparent as
possible.
# Project structure
## 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/msteams` - Microsoft Teams notification service.
- `service/slack` - Slack notification service.
- `service/telegram` - Telegram notification service
## Commits
Commit messages should be well formatted, and to make that "standardized", we
are using Conventional Commits.
You can follow the documentation on
[their website](https://www.conventionalcommits.org).
## 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.
4. Ensure the test suite passes (`make test`).
5. Make sure your code lints (`make lint`).
6. Make sure your code is well formatted (`make fmt`).
## Issues
We use GitHub issues to track public bugs. Please ensure your description is