From a7b7b931d68f4e5bbfd2f4cd4372d54478e98b60 Mon Sep 17 00:00:00 2001 From: cbrgm <24737434+cbrgm@users.noreply.github.com> Date: Tue, 12 Nov 2024 21:57:29 +0000 Subject: [PATCH] docs: rewrite sections in the contributing guide --- .anvil.lock | 2 +- CONTRIBUTING.md | 97 +++++++++++++++++++++++-------------------------- 2 files changed, 47 insertions(+), 52 deletions(-) diff --git a/.anvil.lock b/.anvil.lock index bf371b0..13e5b1b 100644 --- a/.anvil.lock +++ b/.anvil.lock @@ -1,5 +1,5 @@ { - "generated_at": "2024-11-12T21:44:42.656387567Z", + "generated_at": "2024-11-12T21:57:29.032387347Z", "version": "1.2.23", "files": [ { diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85a82b9..1a0bc40 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,54 +1,49 @@ # Contributing Guide -Thank you for your interest in contributing to this project! Your participation is vital in shaping and improving it. Here's an expanded guide to help you get involved effectively: +## Table of Contents +- [Introduction](#introduction) +- [Feature Requests](#feature-requests) +- [Bug Reports](#bug-reports) +- [Pull Requests](#pull-requests) +- [Collaboration](#collaboration) +- [Additional Contributions](#additional-contributions) +- [Collaborator Status](#collaborator-status) +- [Final Notes](#final-notes) + +## Introduction +- Explore [Feature Requests](#feature-requests), [Bug Reports](#bug-reports), and [Pull Requests](#pull-requests) to contribute. +- Got Questions? Email: . + +## Feature Requests +- Check ***[existing requests](https://github.com/cbrgm/cleanup-stale-branches-action/issues)***. +- Submit a new request if needed, explaining benefits and relevance. + +## Bug Reports +- Verify if the bug is already reported via ***[open bugs](https://github.com/cbrgm/cleanup-stale-branches-action/issues)***. +- 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](https://github.com/cbrgm/cleanup-stale-branches-action/pulls)*** 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 . 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! :-) -## Introduction 🌟 - -- **Getting Started**: Browse our [Feature Requests](#feature-requests), [Bug Reports](#bug-reports), [Pull Requests](#pull-requests), and [Writing Documentation](#writing-documentation) sections to find ways you can contribute. -- **Questions or Suggestions?** Feel free to reach out via email at . - -## Feature Requests 🚀 - -Interested in adding a feature? Look through the ***[existing feature requests](https://github.com/cbrgm/cleanup-stale-branches-action/issues)*** first. If your idea is new, submit a ***feature request issue*** explaining the feature's benefits and relevance to this project. - -## Bug Reports 🐛 - -If you encounter a bug, please first verify if it's already known by checking the ***[open bugs](https://github.com/cbrgm/cleanup-stale-branches-action/issues)***. To report a new bug, ***open an issue*** with these specifics: - -- **Description**: Briefly describe the issue. -- **Steps to Reproduce**: Detail how we can recreate the bug. -- **Expected vs. Actual Results**: Contrast what should happen with what actually occurs. -- **Version Info**: Specify the version you're using. - -Providing clear, detailed information accelerates the bug-fixing process. - -## Pull Requests 💡 - -Contributions via Pull Requests (PRs) are highly encouraged. To contribute: - -- **Check Existing PRs**: Before starting, look at ***[existing pull requests](https://github.com/cbrgm/cleanup-stale-branches-action/pulls)***. Collaborating on existing efforts can be more impactful. -- **Minor Improvements & Tests**: For small changes or adding tests, submit PRs anytime. Ensure your changes are well-tested. -- **Code Review Process**: Expect your PRs to be thoroughly reviewed. We assume responsibility for your contributions once merged and appreciate ongoing maintenance from your side. - -## Collaborating 🤝 - -- **Be Responsive**: Engage with any feedback and reviews on your contributions. -- **Small, Focused Commits**: Break your contributions into smaller, manageable parts. -- **Testing**: Verify that your contribution passes all tests. -- **Respectful Interaction**: Remember, collaboration is key. Treat others with respect and patience. - -## Additional Contributions 🎨 - -- **Documentation**: Contributions to improve documentation are always welcome. -- **Feature Enhancements**: Suggest or implement enhancements to existing features. -- **Security Vulnerabilities**: For serious security issues, email me directly at github@cbrgm.net . Otherwise, a PR is a faster approach. - -## Collaborator Status 🌈 - -- **Becoming a Collaborator**: If your PR is merged, congratulations! You might be granted "collaborator status", allowing more direct involvement in the project. -- **Responsibilities**: Collaborators are expected to review PRs, submit new ones, and resolve issues. We ask for thorough code reviews and courteous interaction with new contributors. -- **Inactive Collaborators**: Inactivity may lead to a temporary removal of collaborator status for security reasons, with the possibility of reinstatement later. - -## Final Notes 📚 - -Your contributions are what make this project thrive. We look forward to your ideas, bug reports, code contributions, and documentation updates. Let's continue to build and improve this project together!