Create CONTRIBUTING.md with contribution guidelines

[fkrzski]

The project is MIT-licensed with GitHub Sponsors funding but lacks contributing guidelines. There is no CONTRIBUTING.md file explaining how external contributors can submit issues, propose features, create pull requests, run tests locally, or follow code style conventions.

[gemini-code-assist]

Summary of Changes

Hello @fkrzski, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's accessibility for external contributors by introducing a detailed CONTRIBUTING.md guide. It aims to streamline the contribution process, ensure code quality, and foster a welcoming community by providing clear instructions on everything from reporting issues and suggesting features to setting up a development environment, adhering to coding standards, and submitting pull requests. This addresses the previous lack of formal contribution documentation for the MIT-licensed project.

Highlights

• New Contribution Guidelines: A comprehensive CONTRIBUTING.md file has been added, providing detailed instructions for external contributors.
• Structured Contribution Process: The new guide covers essential aspects such as code of conduct, bug reporting, enhancement suggestions, development setup, and the pull request workflow.
• Code Quality and Style: Specific code style guidelines for shell scripts, YAML files, and Markdown documentation are now documented, along with testing procedures and coverage requirements.
• Commit Message Standards: Clear guidelines for commit message formatting, types, and rules have been established to maintain a consistent commit history.
• README Update: The README.md file has been updated to include a new 'Contributing' section, directing users to the newly created CONTRIBUTING.md.

Changelog

• CONTRIBUTING.md
  • Added a new file outlining comprehensive contribution guidelines.
  • Included sections on code of conduct, bug reporting, enhancement suggestions, development setup, code style, testing, commit messages, and the pull request process.
• README.md
  • Added a new 'Contributing' section.
  • Linked to the newly created CONTRIBUTING.md file.
  • Included a welcoming message for potential contributors.

Activity

• No human activity has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a comprehensive CONTRIBUTING.md file, which is a great addition to the project. The guide is well-structured and covers all the essential aspects of contributing. I've provided a couple of suggestions to fix broken links and improve the clarity of the pull request process for new contributors. Overall, this is an excellent contribution.