From 90d27ce8f8b4b200e74a9f04a78c11369f194811 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Mon, 9 Dec 2024 16:12:27 +0100 Subject: [PATCH] Add contribution guidelines (#8) Signed-off-by: svrnm --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- CONTRIBUTING.md | 55 ++++++++++++++++++++++ 3 files changed, 57 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2d811c4..5cfbce3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -55,7 +55,7 @@ body: label: Checklist description: By submitting this issue, you agree to the following options: - - label: I have read the [contributing guidelines](/cisco-ospo/oss-template/blob/main/CONTRIBUTING.md) + - label: I have read the [contributing guidelines](/cisco-open/app-simulator/blob/main/CONTRIBUTING.md) required: true - label: I have verified this does not duplicate an existing issue required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 74d8bfb..df2ce46 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -48,7 +48,7 @@ body: label: Checklist description: By submitting this request, you agree to the following options: - - label: I have read the [contributing guidelines](/cisco-ospo/oss-template/blob/main/CONTRIBUTING.md) + - label: I have read the [contributing guidelines](/cisco-open/app-simulator/blob/main/CONTRIBUTING.md) required: true - label: | I have verified this does not duplicate an existing feature request diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..74b9dee --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# How to Contribute + +Thanks for your interest in contributing to `app-simulator`! 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. + +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/cisco-open/app-simulator/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 `app-simulator` 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 existing pull requests, and testing patches against real existing + applications that use `app-simulator`. +- Write a test, or add a missing test case to an existing test. + +Thanks again for your interest on contributing to `app-simulator`! + +:heart: