Add MIT license and contributor guidelines
This commit is contained in:
parent
8e945be9b6
commit
3e16a4086d
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Avni Ademi
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
50
README.md
50
README.md
@ -86,8 +86,54 @@ bashgen/
|
||||
|
||||
## License
|
||||
|
||||
[Add your license here]
|
||||
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
The MIT License is a permissive open-source license that allows you to:
|
||||
- ✅ Use the code commercially
|
||||
- ✅ Modify the code
|
||||
- ✅ Distribute the code
|
||||
- ✅ Use privately
|
||||
- ✅ Include license and copyright notice
|
||||
|
||||
## Creator
|
||||
|
||||
Created and maintained by **Avni Ademi** (@avni.ademi)
|
||||
|
||||
## Contributing
|
||||
|
||||
[Add contribution guidelines here]
|
||||
Contributions are welcome and encouraged! This project thrives on community involvement.
|
||||
|
||||
### How to Contribute
|
||||
|
||||
1. **Fork the repository** on GitLab
|
||||
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
|
||||
3. **Make your changes** and test thoroughly
|
||||
4. **Commit your changes** (`git commit -m 'Add some amazing feature'`)
|
||||
5. **Push to the branch** (`git push origin feature/amazing-feature`)
|
||||
6. **Open a Merge Request** on GitLab
|
||||
|
||||
### Contribution Ideas
|
||||
|
||||
- 🐛 Bug fixes and improvements
|
||||
- ✨ New features and enhancements
|
||||
- 📝 Documentation improvements
|
||||
- 🎨 UI/UX improvements
|
||||
- 🔒 Security enhancements
|
||||
- 🧪 Test coverage
|
||||
- 🌐 Translations
|
||||
- 📦 Additional server setup options
|
||||
|
||||
### Code of Conduct
|
||||
|
||||
- Be respectful and inclusive
|
||||
- Welcome newcomers and help them learn
|
||||
- Focus on constructive feedback
|
||||
- Celebrate diversity of ideas and backgrounds
|
||||
|
||||
### Questions?
|
||||
|
||||
Feel free to open an issue on GitLab or reach out to the maintainer.
|
||||
|
||||
---
|
||||
|
||||
**Thank you for contributing!** 🙏
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user