Documentation for OpenceJav Projects.

A collection of documents required for most if not all OpenceJav projects, regarding CONTRIBUTING, LICENSE, CODE

Report Bug ✧ Request Feature ✧ Documentation

Table of Contents

• Table of Contents
• About This Documentation
• Installation & Usage
• File Content
• Contributing
• License
• Contact
• Acknowledgements

About This Documentation

This documentation is a simple collection of file and documents that are required for most open source, contribution based projects. The idea is to have a single repository with all the necessary files to copy and paste into new projects. This just makes it easier to kick-start them without having to worry about things like CONTRIBUTING, LICENSE, etc.

I'm sure there are other ways to do this, and there are plenty of templates online that you can use, but I much prefer having a single repository that can be cloned and copied with everyone in a single place rather than having to explore the internet for them one by one.

Installation & Usage

To use this repo, simply clone it and copy the files you need into your own projects. I usually put them in a folder called docs/ in the root of the repo, but you can put them wherever you see best fit.

git clone <repo-url>

To copy the files, you can use the following commands:

cp -r docs-required/CONTRIBUTING.md <your-project>/docs/CONTRIBUTING.md
cp -r docs-required/LICENSE <your-project>/docs/LICENSE
cp -r docs-required/README.md <your-project>/docs/README.md
...

or just drag and drop them all into your project. I would recommend to delete the .git folder and the assets/ folder as they are not needed in your project, alongside the README.md since it is specific to this repo and this repo only.

File Content

• CONTRIBUTING.md - The contributing guidelines for any project.
• LICENSE - The license file for any project.
• README.md - The README file for this project (don't use this in your project).
• CODE_OF_CONDUCT.md - The code of conduct for any project.
• SECURITY.md - The security policy for any project.
• SUPPORT.md - (coming soon) The support policy for any project.
• CODEOWNERS - The code owners for any project.

Contributing

Contributions are what make open-source such an amazing place to learn, get inspired, and create. Any contributions you make to this repository is greatly appreciated.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

If you have any questions or concerns, feel free to reach out to me at my email or open an issue in this repository following the proper guidelines in the CONTRIBUTING.md file.

Acknowledgements

Thank you to all the following people for their contributions to this repository, to the moon and back! 🚀

TODO: Add contributors here (if any).