| 1 |
# Contributing |
# Contributing |
| 2 |
|
|
| 3 |
Thanks for deciding to contribute in this project! |
Thanks for thinking about contributing to this project! |
| 4 |
This file contains some basic guidelines about contributions. |
This file contains some basic guidelines about contributions. |
| 5 |
|
|
| 6 |
### Useful links |
## Useful links |
| 7 |
- [Issues](https://github.com/onesoft-sudo/sudobot/issues) |
- [Issues](https://github.com/onesoft-sudo/sudobot/issues) |
| 8 |
- [Docs](https://onesoft-sudo.github.io/sudobot/) |
- [Docs](https://onesoft-sudo.github.io/sudobot/) |
| 9 |
- [Support Email](mailto:[email protected]) |
- [Support Email](mailto:[email protected]) |
| 10 |
|
|
| 11 |
### How to report a bug |
## How to report a bug |
| 12 |
|
|
| 13 |
If you've found a bug, please make sure that everything is tested correctly and it is not a mistake. Then if you're 99.99% sure that it's a bug, you can create an issue on the GitHub repo. |
If you've found a bug, you can create an issue on the GitHub repo. Include as much information as possible, so that we can help you as quick as possible. |
| 14 |
Also make sure that a similar issue does not exist previously. |
Also it's best to make sure that a similar issue does not exist previously. |
| 15 |
Please note that security issues should be reported via email only and should not be discussed in public, because that might cause more issues rather that resolving it. |
Please note that security issues should be reported via email only and should not be discussed in public, because that might cause more issues rather that resolving it. |
| 16 |
|
|
| 17 |
### How to submit changes |
## How to submit changes |
| 18 |
|
|
| 19 |
We highly recommend you to fork this repo on GitHub, clone it locally and then start working on it. If you've already did that, then you can create a pull request on GitHub. We'll review your changes and if everything looks OK we'll merge it. |
Get started by forking this repository, then cloning it locally, and finally committing your work and creating a PR. If your PR follows our contribution guidelines and standards, we will merge it. We might suggest you to make some changes to your code, in that case feel free to share your opinions and thoughts about your approaches of doing things and our suggestions. |
| 20 |
|
|
| 21 |
### Getting Help |
## Commit Guidelines |
| 22 |
|
|
| 23 |
You can email at [email protected]. |
We strictly follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). We highly suggest that you check out the [Conventional Commit Specification](https://www.conventionalcommits.org/en/v1.0.0/#specification) if you're not familiar with it. |
| 24 |
|
|
| 25 |
|
The following types are currently allowed to be used in commit messages: |
| 26 |
|
|
| 27 |
|
* `feat` - New features |
| 28 |
|
* `fix` - Bug fixes |
| 29 |
|
* `perf` - Performance improvements |
| 30 |
|
* `ci` - CI configuration file updates (e.g. GitHub Action Workflows) |
| 31 |
|
* `build` - Build system related commits (e.g. updates to the build script) |
| 32 |
|
* `refactor` - Code changes that neither adds a new feature nor fixes a bug |
| 33 |
|
* `style` - Code modifications that do not change the meaning of the code (e.g. formatting) |
| 34 |
|
* `docs` - Documentation updates |
| 35 |
|
* `test` - Unit/integration test related commits |
| 36 |
|
* `revert` - A commit that reverts another commit |
| 37 |
|
* `chore` - Commits that do not fit in the other types |
| 38 |
|
|
| 39 |
|
### Partial commits |
| 40 |
|
|
| 41 |
|
In case if you have to commit **incomplete** changes, then we recommend explicitly stating so in your commit message by appending `(x/y)` to the header of your commit message, where `x` is the number of steps you've completed, and `y` is the total amount of steps required to make the change completely functional. For example: |
| 42 |
|
|
| 43 |
|
``` |
| 44 |
|
feat(automod): verification system (1/3) |
| 45 |
|
``` |
| 46 |
|
|
| 47 |
|
This would mean this commit is not complete, and two more commits will be pushed later to make this feature completely functional. |
| 48 |
|
|
| 49 |
|
> [!WARNING] |
| 50 |
|
> Do not push a partial commit in release-specific branches except for `main`. The `main` branch rapidly changes, and contains unstable changes. However, the other branches are kept as-is to keep a history of the older releases. You can also create a new branch specifically for the feature you're working on. Then when your code gets merged into the main branch, you can delete the feature branch. |
| 51 |
|
|
| 52 |
|
### Signing-off commits |
| 53 |
|
|
| 54 |
|
We require contributors to [Sign-off Commits](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) before they are merged/pushed into the remote branches. This is done to make sure the contributors acknowledge that the code they're submitting is theirs and they have the appropriate rights to do so. By signing-off a commit, a you explicitly agrees that: |
| 55 |
|
|
| 56 |
|
* The code you submit is yours; |
| 57 |
|
* You have the appropriate legal rights to submit the code; |
| 58 |
|
* You agree to the terms and conditions of the [GNU Affero General Public License](https://gnu.org/licenses/agpl-3.0.html), and acknowledge that your code is now a part of a free software which can be seen, studied or modified by anyone over the world; |
| 59 |
|
|
| 60 |
|
If a commit does not contain a `Signed-off-by` header, we will ask you to explicitly state that you agree to the above terms before merging your code. |
| 61 |
|
|
| 62 |
|
## Getting Help |
| 63 |
|
|
| 64 |
|
You can email at [email protected]. |
Parent Directory
| 
Revision Log
| 
Patch