You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
58 lines
2.3 KiB
58 lines
2.3 KiB
|
2 years ago
|
# Contributing to Interview Coder - Unlocked Edition
|
||
|
|
|
||
|
|
First off, thank you for considering contributing to Interview Coder! We created this tool to help the community, and we welcome improvements that make it better for everyone.
|
||
|
|
|
||
|
|
## Our Community Values
|
||
|
|
|
||
|
|
- **Collaborative Development**: We believe in building together rather than fragmenting our efforts
|
||
|
|
- **Open Access**: We want to keep this tool accessible to everyone who needs it
|
||
|
|
- **Continuous Improvement**: The tool should get better with each contribution
|
||
|
|
|
||
|
|
## How to Contribute
|
||
|
|
|
||
|
|
### 1. Fork the Repository
|
||
|
|
|
||
|
|
- Click the "Fork" button at the top of the repository page
|
||
|
|
- Clone your fork locally: `git clone https://github.com/YOUR-USERNAME/interview-coder-unlocked.git`
|
||
|
|
|
||
|
|
### 2. Create a Branch
|
||
|
|
|
||
|
|
- Create a branch for your feature: `git checkout -b feature/your-feature-name`
|
||
|
|
|
||
|
|
### 3. Make Your Changes
|
||
|
|
|
||
|
|
- Implement your changes, improvements, or bug fixes
|
||
|
|
- Make sure to test your changes thoroughly
|
||
|
|
- Ensure your code follows the existing style
|
||
|
|
|
||
|
|
### 4. Submit a Pull Request
|
||
|
|
|
||
|
|
- Push your changes to your fork: `git push origin feature/your-feature-name`
|
||
|
|
- Go to the original repository and create a Pull Request
|
||
|
|
- Describe your changes in detail
|
||
|
|
- Reference any related issues
|
||
|
|
|
||
|
|
## Guidelines for Modifications
|
||
|
|
|
||
|
|
Under the AGPL-3.0 license, you are free to modify the code, but we strongly encourage you to:
|
||
|
|
|
||
|
|
1. **Contribute Back**: Submit your improvements as Pull Requests to the main repository
|
||
|
|
2. **Share Openly**: Make your modifications available to the public, especially if you deploy a modified version
|
||
|
|
3. **Maintain Attribution**: Keep the original copyright notices and license information
|
||
|
|
|
||
|
|
## License Compliance
|
||
|
|
|
||
|
|
Remember that this project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). This means:
|
||
|
|
|
||
|
|
- You must disclose your source code when you distribute the software
|
||
|
|
- If you modify the software and run it on a server that users interact with, you must make the source code of your modified version available to those users
|
||
|
|
- Any modifications you make must also be licensed under the AGPL-3.0
|
||
|
|
|
||
|
|
## Community Guidelines
|
||
|
|
|
||
|
|
- Be respectful and constructive in your comments and feedback
|
||
|
|
- Help review other contributors' pull requests
|
||
|
|
- Report bugs and issues clearly with steps to reproduce
|
||
|
|
|
||
|
|
Thank you for helping make Interview Coder better for everyone!
|