mirror of
https://github.com/ChrisTitusTech/winutil
synced 2026-06-04 14:17:27 +00:00
Gabi
076ef02b2c
* Delete docs/assets/images/Complie.png * Delete docs/assets/images/Commit-GHD.png * Delete docs/assets/images/Discard-GHD.png * Delete docs/assets/images/Push-Commit.png * Delete docs/assets/images/Fork-Button-Dark.png * Delete docs/assets/images/Fork-Button-Light.png * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md
2.3 KiB
2.3 KiB
Contributing Code
Before You Start
- Keep each pull request focused on a single feature or fix.
- Avoid unnecessary formatting changes or large unrelated edits.
- Document what changed and why in your PR description.
Basic Git Workflow
1. Fork the Repository
Go to the ChrisTitusTech/winutil repository on GitHub and click the Fork button in the top right corner.
2. Clone Your Fork
git clone https://github.com/YOUR_USERNAME/winutil.git
cd winutil
3. Create a Branch
Never work directly on main.
Create a branch related to your change:
git checkout -b feature-name
Example:
git checkout -b add-firefox-tweak
4. Edit the Code
Open the project in your preferred text editor and make your changes.
Keep changes small and focused.
5. Test Your Changes
Open Pwsh (Not Powershell) as Administrator.
Go to the project folder:
cd path\to\winutil
Run:
.\Compile.ps1 -Run
Verify:
- WinUtil launches correctly
- Your feature works
- Nothing else breaks
If something fails, fix it before committing.
6. Review Your Changes
Check what changed:
git status
Review the diff:
git diff
Make sure you did not accidentally modify unrelated files.
7. Commit Your Changes
Stage files:
git add .
Commit them:
git commit -m "Add feature description"
Example:
git commit -m "Add Firefox package tweak"
8. Push Your Branch
git push origin branch-name
Example:
git push origin add-firefox-tweak
9. Open a Pull Request
Go to your fork on GitHub.
GitHub will show a button to create a pull request.
Before submitting:
- Explain what changed
- Explain why you changed it
- Make sure unrelated files are not included
Once submitted, maintainers will review your PR.