Add contributing document

[mrheinen]

PR Type

Documentation, Enhancement

---

Description

• Created a new CONTRIBUTING.md file with detailed guidelines for contributors
• Added a "Contributing" section to the README.md file
• Outlined key rules for making contributions, including:
  • Creating GitHub issues for larger changes
  • Adding or updating tests
  • Maintaining consistent code style
  • Expectations for PR review time
• Improved project documentation to encourage and guide potential contributors

---

Changes walkthrough 📝

Relevant files

Documentation

CONTRIBUTING.md New contribution guidelines document                                          CONTRIBUTING.md Added new file with contribution guidelines Outlined rules for making contributions Emphasized the importance of testing and consistent coding style Mentioned the process for larger changes and PR review timeframe +7/-0      README.md Update README with contribution information                            README.md Added a new "Contributing" section Included a brief invitation for contributions Added a reference to the new CONTRIBUTING.md file +4/-0

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro[bot]]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-pro[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	✅ Enhance the structure and content of the contribution guidelines to provide more comprehensive information for potential contributors ___ **Consider adding a section about the code review process to set clear expectations for contributors. This could include information about how PRs are reviewed, the expected timeline, and any specific criteria used in the review process.** [CONTRIBUTING.md [1-2]](https://github.com/mrheinen/lophiid/pull/14/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R1-R2) ```diff -Contributions are awesome!! Please fork the repo, make the changes and send a PR -to merge those changes. There are a few rules: +# Contributing to Our Project +We welcome and appreciate contributions! Here's how you can contribute: + +1. Fork the repository +2. Make your changes +3. Submit a Pull Request (PR) + +## Contribution Guidelines: + ``` `[Suggestion has been applied]` Suggestion importance[1-10]: 8 Why: The suggestion significantly improves the structure and content of the contribution guidelines, providing clearer and more comprehensive information for potential contributors.	8
	Enhance the contributing section in the README to provide more context and encourage contributions ___ **Expand the contributing section in the README to provide more context and encourage contributions. Include a brief overview of the contribution process and link to the CONTRIBUTING.md file for detailed guidelines.** [README.md [139-142]](https://github.com/mrheinen/lophiid/pull/14/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R139-R142) ```diff # Contributing -Contributions are super welcome! Just fork the repo and send us a PR. Please -regularly check the [CONTRIBUTING.md](./CONTRIBUTING.md) for general guidelines +We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, your efforts are appreciated. +To contribute: +1. Fork the repository +2. Create your feature branch +3. Commit your changes +4. Push to the branch +5. Open a Pull Request + +Please review our [Contribution Guidelines](./CONTRIBUTING.md) for detailed information on our development process, coding standards, and how to submit pull requests. + ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 8 Why: This suggestion significantly expands the contributing section in the README, providing a clear process overview and encouraging more contributions.	8
Best practice	Provide more detailed information about the project's coding standards to ensure consistency across contributions ___ **Add information about the project's coding standards, including formatting guidelines, naming conventions, and any specific practices unique to this project. This will help ensure consistency across contributions.** [CONTRIBUTING.md [6]](https://github.com/mrheinen/lophiid/pull/14/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R6-R6) ```diff -* Keep the style of your code consistent with the rest of the project +* Follow our coding standards: + - Use consistent formatting (we recommend using [tool name] for auto-formatting) + - Follow our naming conventions (camelCase for variables, PascalCase for classes, etc.) + - Write clear, self-documenting code + - [Any other specific coding practices] ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 7 Why: This suggestion expands on the existing guideline about code style consistency, offering more specific and actionable advice for contributors.	7
	Add guidelines for writing clear and consistent commit messages to improve the project's git history ___ **Include information about the project's commit message conventions. This helps maintain a clean and informative git history, making it easier to track changes and understand the purpose of each commit.** [CONTRIBUTING.md [7]](https://github.com/mrheinen/lophiid/pull/14/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055R7-R7) ```diff * Allow for some delay in reviewing your PR (day or two max) +* Follow our commit message conventions: + - Use the imperative mood in the subject line + - Limit the subject line to 50 characters + - Capitalize the subject line + - Do not end the subject line with a period + - Separate subject from body with a blank line + - Use the body to explain what and why vs. how ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 7 Why: The suggestion adds valuable information about commit message conventions, which was not present in the original content and can significantly improve the project's git history.	7

[github-actions[bot]]

Preparing PR description...

[github-actions[bot]]

Preparing review...