From d272b93100789df4d38ff6813c17f4109a798790 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Pinson?= Date: Wed, 25 Sep 2024 15:59:23 +0200 Subject: [PATCH] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Raphaël Pinson --- CONTRIBUTING.md | 64 ++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 55 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f46a2e..7d29721 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,57 @@ -## Contributing +# How to Contribute -- With issues: - - Use the search tool before opening a new issue. - - Please provide source code and commit sha if you found a bug. - - Review existing issues and provide feedback or react to them. +Thanks for your interest in contributing to `credly-go`! Here are a few +general guidelines on contributing and reporting bugs that we ask you to review. +Following these guidelines helps to communicate that you respect the time of the +contributors managing and developing this open source project. In return, they +should reciprocate that respect in addressing your issue, assessing changes, and +helping you finalize your pull requests. In that spirit of mutual respect, we +endeavor to review incoming issues and pull requests within 10 days, and will +close any lingering issues or pull requests after 60 days of inactivity. -- With pull requests: - - Open your pull request against `main` - - It should pass all tests in the available continuous integration systems such as GitHub Actions. - - You should add/modify tests to cover your proposed code changes. +Please note that all of your interactions in the project are subject to our +[Code of Conduct](/CODE_OF_CONDUCT.md). This includes creation of issues or pull +requests, commenting on issues or pull requests, and extends to all interactions +in any real-time space e.g., Slack, Discord, etc. + +## Reporting Issues + +Before reporting a new issue, please ensure that the issue was not already +reported or fixed by searching through our [issues list](https://github.com/isovalent/credly-go/issues). + +When creating a new issue, please be sure to include a **title and clear +description**, as much relevant information as possible, and, if possible, a +test case. + +**If you discover a security bug, please do not report it through GitHub. +Instead, please see security procedures in [SECURITY.md](/SECURITY.md).** + +## Sending Pull Requests + +Before sending a new pull request, take a look at existing pull requests and +issues to see if the proposed change or fix has been discussed in the past, or +if the change was already implemented but not yet released. + +We expect new pull requests to include tests for any affected behavior, and, as +we follow semantic versioning, we may reserve breaking changes until the next +major version release. + +## Other Ways to Contribute + +We welcome anyone that wants to contribute to `credly-go` to triage and +reply to open issues to help troubleshoot and fix existing bugs. Here is what +you can do: + +- Help ensure that existing issues follows the recommendations from the + _[Reporting Issues](#reporting-issues)_ section, providing feedback to the + issue's author on what might be missing. +- Review and update the existing content of our + [Wiki](https://github.com/isovalent/credly-go/wiki) with up-to-date + instructions and code samples. +- Review existing pull requests, and testing patches against real existing + applications that use `credly-go`. +- Write a test, or add a missing test case to an existing test. + +Thanks again for your interest on contributing to `credly-go`! + +:heart: