Create CONTRIBUTING.md for project guidelines

Added a comprehensive contributing guide for Freedom Loader, outlining how to report issues, submit pull requests, and improve documentation.
This commit is contained in:
MasterAcnolo
2025-12-20 13:35:21 +01:00
committed by GitHub
parent 37eeed583a
commit 19ab77501b

66
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,66 @@
# Contributing to Freedom Loader
Welcome! Thanks for being interested in Freedom Loader. Your contributions-bug reports, feature ideas, or code improvements-are always appreciated. Every contribution makes Freedom Loader better 💪
---
## 1. Check Before Contributing
- Make sure your issue, bug, or feature request doesn't already exist.
- Search issues and pull requests before creating a new one.
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md).
---
## 2. Report an Issue
Found a bug, weird behavior, or have an idea? Open an [**issue**](https://github.com/MasterAcnolo/Freedom-Loader/issues) using the **Bug Report template**.
Make sure to include:
- Steps to reproduce the issue
- App version and environment (OS, Node, Browser, etc.)
- Logs if possible: `C:\Users\[USERNAME]\AppData\Local\FreedomLoader\logs\LOGS-20xx-xx-xx.log`
- Screenshots if relevant
---
## 3. Submit a Pull Request
To fix a bug, add a feature, or improve docs:
1. Fork the repository
2. Create a branch: `git checkout -b feature/my-awesome-feature`
3. Make your changes
4. Add tests or verification steps
5. Test everything locally
6. Open a PR to the `main` branch
**Tips for PRs:**
- Keep titles and descriptions clear and concise
- Document what you change and why
- Follow existing code style (camelCase for variables/functions)
- Small commits focused on a single purpose are easier to review
---
## 4. Improve the Documentation
Docs are important: README, wiki, guides… If something is unclear, improve it!
Small contributions like fixing typos or adding examples are always welcome.
---
## 5. Testing & Verification
- Test new features thoroughly
- Ensure bug fixes actually fix the reported issue
- Include any relevant logs or screenshots
---
## 6. Review & Merge
- After submitting a PR, it will be reviewed by maintainers
- Be open to feedback and changes
- We try to respond quickly, but sometimes have other priorities
---
## 7. Code of Conduct
Please contribute respectfully and constructively. Everyone is welcome as long as discussions remain polite and productive.
---
Thanks to Zakaria for the website icon. Check him out here: [IG Link](https://www.instagram.com/designmark_studio/) 🔥