H0llyW00dzZ/GoGenAI-Terminal-Chat
H0llyW00dzZ/GoGenAI-Terminal-Chat
1
0
Fork 0
mirror of https://github.com/H0llyW00dzZ/GoGenAI-Terminal-Chat.git synced 2025-02-06 11:00:02 +00:00
Code Releases Activity

Update CONTRIBUTING.md & README.md

Browse Source 
- [+] docs: update CONTRIBUTING.md with more detailed guidelines and format
- [+] docs: update README.md to link to CONTRIBUTING.md for contribution details
This commit is contained in:
H0llyW00dzZ 2024-02-11 06:07:11 +07:00
parent a082434241
commit 8853a7b947
Signed by: H0llyW00dzZ
GPG Key ID: 05C7FFFC0845C930
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -1,3 +1,17 @@
Contributions is always welcome! If you're able to write code that adheres to a cyclomatic complexity of 5 or less per function,
please feel free to submit a pull request. Pull requests that do not meet this criterion will be rejected.
Alternatively, if you encounter any issues, do not hesitate to submit an issue report.
<pre>
______ ______ ___ ____
/ ____/___ / ____/__ ____ / | / _/
/ / __/ __ \/ / __/ _ \/ __ \/ /| | / /
/ /_/ / /_/ / /_/ / __/ / / / ___ |_/ / Contribution Guidelines
\____/\____/\____/\___/_/ /_/_/ |_/___/
Copyright (©️) 2024 @H0llyW00dzZ All rights reserved.
</pre>
### 🎯 Contribution Guidelines
1. **Code Complexity**: Ensure that each function has a cyclomatic complexity of 5 or less. Pull requests with functions exceeding this complexity will not be accepted.
> [!TIP]
> If you're unable to write code that adheres to a cyclomatic complexity of 5 or less per function, you can refer to the Go tour [here](https://go.dev/tour/).
2. **Pull Requests**: You are encouraged to submit pull requests with improvements or new features that comply with our complexity rules.
3. **Issue Reporting**: If you find any problems or bugs, please report them by submitting an issue [here](https://github.com/H0llyW00dzZ/GoGenAI-Terminal-Chat/issues/new/choose).

2
README.md
View File

@ -329,7 +329,7 @@ By following these tips, you can write simple, easy-to-understand functions that
---
## 🙌 Contributing
Contributions is always welcome! If you're able to write code that adheres to a cyclomatic complexity of 5 or less per function, please feel free to submit a pull request. Pull requests that do not meet this criterion will be rejected. Alternatively, if you encounter any issues, do not hesitate to submit an issue report.
Available [`here`](CONTRIBUTING.md)
> [!TIP]
> If you're unable to write code that adheres to a cyclomatic complexity of 5 or less per function, you can refer to the Go tour [here](https://go.dev/tour/).