mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
docs
This commit is contained in:
+8
-3
@@ -29,11 +29,11 @@ All types of contributions are encouraged and valued. Please make sure to read t
|
||||
## Code of Conduct
|
||||
|
||||
This project and everyone participating in it is governed by the
|
||||
[Argenta Code of Conduct](https://github.com/koloideal/Argenta/blob//CODE_OF_CONDUCT.md).
|
||||
[Argenta Code of Conduct](https://github.com/koloideal/Argenta/blob/main/CODE_OF_CONDUCT.md).
|
||||
By participating, you are expected to uphold this code. Please report unacceptable behavior
|
||||
to .
|
||||
|
||||
---
|
||||
-----
|
||||
|
||||
## I Have a Question
|
||||
|
||||
@@ -64,7 +64,7 @@ Depending on how large the project is, you may want to outsource the questioning
|
||||
- Forum
|
||||
-->
|
||||
|
||||
---
|
||||
-----
|
||||
|
||||
## I Want To Contribute
|
||||
|
||||
@@ -110,6 +110,7 @@ Once it's filed:
|
||||
|
||||
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
|
||||
|
||||
-----
|
||||
|
||||
### Suggesting Enhancements
|
||||
|
||||
@@ -136,6 +137,8 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/koloid
|
||||
|
||||
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
|
||||
|
||||
-----
|
||||
|
||||
### Your First Code Contribution
|
||||
|
||||
Unsure where to begin contributing to Argenta? You can start by looking through `good first issue` and `help wanted` issues on our GitHub repository. These are issues that are well-suited for new contributors.
|
||||
@@ -179,6 +182,8 @@ To get started with your first code contribution, please follow these steps to s
|
||||
```
|
||||
9. Open a Pull Request from your forked branch to the `main` branch of the official Argenta repository. Provide a clear description of the problem and your solution. Include the relevant issue number if applicable.
|
||||
|
||||
-----
|
||||
|
||||
### Improving The Documentation
|
||||
|
||||
Good documentation is crucial for any project. We use Sphinx to generate our documentation from source files located in the `docs/` directory. We welcome any improvements, from fixing a simple typo to writing a whole new section.
|
||||
|
||||
Reference in New Issue
Block a user