jlammi/winutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/winutil synced 2026-02-04 23:10:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation & ReadMe Cleanup (#2310)

Browse Source 
* cleanup readme & create docs

* add icons

* Change Title to include Logo

* fix title

* title fix 2.0

* revert title

* Update .docs/Overview.md

Co-authored-by: Mr.k <mineshtine28546271@gmail.com>

* added link to latest release at download count

* moved files from wiki folder

* fix path

* fix2

* fix3

* add compatibility with new docs site

* fix link

* remove documentation

* fix known issues

---------

Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
Co-authored-by: Chris Titus <contact@christitus.com>
This commit is contained in:
MyDrift
2024-07-13 18:03:09 +02:00
committed by GitHub
parent bdb60b0b44
commit 37089aeb5c
8 changed files with 10 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@@ -1,20 +0,0 @@
## Issues
If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs, or consider feature requests.
## Contribute Code
Pull Requests are now handled directly on the **MAIN branch**. This was done since we can now select specific releases to launch via releases in GitHub.
If you're doing code changes, then you can submit a PR to `main` branch, but I am very selective about these.
> [!WARNING]
> Do not use a code formatter, massive amounts of line changes, and make multiple feature changes.
> EACH FEATURE CHANGE SHOULD BE IT'S OWN Pull Request!
When creating pull requests, it is essential to thoroughly document all changes made. This includes, but not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes, document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in denial of the pull request. Additionally, Any code lacking sufficient documentation may also be denied.
By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
> [!NOTE]
> When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.