Contributing Guide

Table of Contents

• Introduction
• Feature Requests
• Bug Reports
• Pull Requests
• Collaboration
• Additional Contributions
• Collaborator Status
• Final Notes

Introduction

• Explore Feature Requests, Bug Reports, and Pull Requests to contribute.
• Got Questions? Email: github@cbrgm.net.

Feature Requests

• Check existing requests.
• Submit a new request if needed, explaining benefits and relevance.

Bug Reports

• Verify if the bug is already reported via open bugs.
• Report new bugs with:
  • Description: Summary of the issue.
  • Steps to Reproduce: Clear steps.
  • Expected vs. Actual Results.
  • Version Info.

Pull Requests

• Review existing PRs first.
• Submit small, well-tested PRs anytime.
• PRs undergo thorough reviews; responsiveness is key.

Collaboration

• Engage with feedback and reviews.
• Small, Focused Commits: Easier to review and test.
• Respectful Interaction: Collaboration thrives on patience.

Additional Contributions

• Improve documentation or suggest feature enhancements.
• Report serious security issues to github@cbrgm.net. Use PRs for less critical fixes.

Collaborator Status

• After a PR is Merged: Potential "collaborator status."
• Responsibilities: Review PRs, resolve issues, and submit new contributions.
• Inactive Collaborators: May be temporarily removed for security but reinstated later.

Your ideas, reports, and contributions make this project valuable for everyone. Thank you so much for your help! :-)