chore: Update CONTRIBUTING.md #25
1 changed files with 18 additions and 7 deletions
|
@ -6,15 +6,21 @@ contributions from the community to help improve the project.
|
||||||
## Reporting Issues
|
## Reporting Issues
|
||||||
|
|
||||||
If you encounter any issues or bugs while using oxidetalis, please open a new
|
If you encounter any issues or bugs while using oxidetalis, please open a new
|
||||||
issue on the Forgejo repository. When reporting an issue, please provide as much
|
issue on our [issue tracker][issue-tracker]. When reporting an issue, please provide as much
|
||||||
detail as possible, including steps to reproduce the issue and any relevant
|
detail as possible, including steps to reproduce the issue and any relevant
|
||||||
error messages.
|
error messages.
|
||||||
|
|
||||||
## Feature Requests
|
## Feature Requests
|
||||||
|
|
||||||
If you have a feature request or an idea for improving oxidetalis, we encourage
|
If you have a feature request or an idea for improving oxidetalis, we encourage
|
||||||
you to open a new issue on the Forgejo repository. Please describe the feature
|
you to open a new issue on our [issue tracker][issue-tracker]. Please describe the feature or
|
||||||
or improvement in detail and provide any relevant context or examples.
|
improvement in detail and provide any relevant context or examples.
|
||||||
|
|
||||||
|
## Contributors list
|
||||||
|
|
||||||
|
We have a list of contributors in the `CONTRIBUTORS.md` file. If your email is
|
||||||
|
public, we will add you to the list. If you don't want to be added, please let
|
||||||
|
us know.
|
||||||
|
|
||||||
## Developer Certificate of Origin (DCO)
|
## Developer Certificate of Origin (DCO)
|
||||||
Please note that all contributions to oxidetalis must be made under the terms of
|
Please note that all contributions to oxidetalis must be made under the terms of
|
||||||
|
@ -38,10 +44,14 @@ git commit -s -m "feat: Add new feature"
|
||||||
> `Signed-off-by` line if it is missing.
|
> `Signed-off-by` line if it is missing.
|
||||||
|
|
||||||
## Writing Code
|
## Writing Code
|
||||||
Before you start writing code, please open a new issue first to discuss the
|
Before you start writing code, please open a new [issue][issue-tracker] first to
|
||||||
proposed changes. This will help ensure that your contribution is aligned with
|
discuss the proposed changes. This will help ensure that your contribution is
|
||||||
the project's goals and that you are not duplicating work that is already in
|
aligned with the project's goals and that you are not duplicating work that is
|
||||||
progress or has been completed by someone else.
|
already in progress or has been completed by someone else.
|
||||||
|
|
||||||
|
After your issue has confirmed, you can start writing code. then open your PR at
|
||||||
|
our [Forgejo](https://git.4rs.nl/OxideTalis/oxidetalis/pulls) instance and
|
||||||
|
follow the guidelines below.
|
||||||
|
|
||||||
### Rust Version
|
### Rust Version
|
||||||
In the oxidetalis project, we always try to stay on the lowest MSRV possible for
|
In the oxidetalis project, we always try to stay on the lowest MSRV possible for
|
||||||
|
@ -181,3 +191,4 @@ contribution.
|
||||||
Happy contributing!
|
Happy contributing!
|
||||||
|
|
||||||
[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/
|
[Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/
|
||||||
|
[issue-tracker]: https://git.4rs.nl/OxideTalis/oxidetalis/issues
|
Loading…
Reference in a new issue