mirror/antimicrox
1
0
Fork 0
mirror of https://github.com/AntiMicroX/antimicrox.git synced 2025-12-23 23:29:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Write contributing guide

Browse Source 
[skip ci]
This commit is contained in:
Paweł Kotiuk
2023-01-29 21:54:16 +01:00
parent 3cc7fe2d30
commit 16d1cd243c
2 changed files with 31 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,30 @@
# Contributing to AntiMicroX
We welcome and appreciate all contributions to this open source project!
## How to contribute
Before contributing, please take a moment to review the following guidelines:
1. Check the [issue tracker](https://github.com/AntiMicroX/antimicrox/issues) to see if the issue or feature you're interested in has already been reported or discussed.
2. If you would like to suggest a new feature, please [start a new issue](https://github.com/AntiMicroX/antimicrox/issues/new/choose) to discuss the proposal.
3. If you would like to contribute code, check the [project's coding guidelines](https://github.com/AntiMicroX/antimicrox/wiki/Coding-guidelines) and make sure your code is well-documented preferably in doxygen-compatible format.
4. Submit a pull request to the main repository for review. In case of preparing bigger changes into the codebase it is recommended to firstly open `Draft Pull Request` to show what you are going to do.
During coding you may find [AntiMicroX online docs](https://antimicrox.github.io/doxygen/) useful.
## Translation
Translation process is handled via [Weblate](https://weblate.org/). If you want to help just click this [link](https://hosted.weblate.org/engage/antimicrox).
Translation status
<a href="https://hosted.weblate.org/engage/antimicrox/">
<img src="https://hosted.weblate.org/widgets/antimicrox/-/gui/multi-auto.svg" alt="Translation status" />
</a>
More information about translating can be found [here](https://github.com/AntiMicroX/antimicrox/wiki/Translating-AntiMicroX).
## License
By contributing to this project, you agree to license your contributions under the GPL-3.0 license.

8
README.md
View File

@@ -186,15 +186,9 @@ for yourself, [here](https://github.com/AntiMicroX/antimicrox-profiles) is the f
a question or share a suggestion, you can do that on the antimicrox page or on the
[antimicrox-profiles](https://github.com/AntiMicroX/antimicrox-profiles) page.
## Support
In order to obtain support, you can post an issue [here](https://github.com/AntiMicroX/antimicrox/issues).
## Contributing
Any contributions into codebase are welcome.
Before coding checking our simple [coding guideline](https://github.com/AntiMicroX/antimicrox/wiki/Coding-guidelines) is recommended.
If you are not sure about a way of fixing/implementing something you can just create draft Pull Request showing your attempt.
Any contributions into codebase are welcome. You can find contribution guide [here](./CONTRIBUTING.md).
### Translation