diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..56def6a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,58 @@ +xx# Contributing to GitProve + +First and foremost, thank you for considering contributing to GitProve! We value every contribution, whether it's submitting a new project, improving documentation, or fixing bugs. This document provides guidelines to ensure smooth collaboration and contributions. + +## Code of Conduct + +By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). Please ensure you read and understand its contents. + +## How Can I Contribute? + +### 1. Proposing a New Project + +- **Fork** the GitProve repository. +- Create a markdown file with your project details in the `projects` directory. +- Submit a **Pull Request** with a clear title and description. +- Wait for the review. We'll get back to you as soon as possible! + +### 2. Reporting Bugs + +If you encounter any bugs or issues, please: + +- Check if the bug has already been reported in the [Issues](https://github.com/Git-Prove/GitProve-Projects/issues) section. +- If not, open a new issue, providing a clear description and steps to reproduce the bug. + +### 3. Suggesting Enhancements + +We're always open to improvements! If you have suggestions: + +- Check the [Issues](https://github.com/Git-Prove/GitProve-Projects/issues) section to see if it's already been proposed. +- If not, open a new issue, detailing your suggestion and its benefits. + +### 4. Pull Requests + +- Ensure any install or build dependencies are removed before the end of the layer when doing a build. +- Update the `README.md` with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters. +- Increase the version numbers in any examples files and the `README.md` to the new version that this Pull Request would represent. + +## Style Guides + +### Git Commit Messages + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or fewer. +- Reference issues and pull requests liberally after the first line. + +### Markdown Style + +Follow the [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). + +## Additional Notes + +- Please ensure that your code has proper comments for understanding. +- If adding new tools or software dependencies, ensure they are compatible with the project's license. + +--- + +Thank you for being an integral part of GitProve! Your contributions drive the community forward, and we're excited to see the innovations you bring.