From f5bbbcef7408329ee2c978bb824d30cf42f57d63 Mon Sep 17 00:00:00 2001 From: hebaphilip Date: Thu, 25 Jan 2024 15:19:55 +0530 Subject: [PATCH] Updated contributing.md and added CODEOWNERS --- CODEOWNERS | 15 +++++++++++++++ contributing.md | 22 +++++++++++++++++----- 2 files changed, 32 insertions(+), 5 deletions(-) create mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..0cce5bb --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,15 @@ +# What does "ownership" mean? +# What does "ownership" mean? This team is the **first contact** when it comes to anything regarding this package. For +# example, technical, design, behavioral and functional changes and questions. + +# What does "ownership" NOT mean? +# Ownership does NOT mean, that the owner-team is the only team who may change code in this component. But you should +# consult the owner-team if you plan bigger changes. +# Ownership does NOT mean, that the owner-team is the only team responsible for the stability and functioning of the +# component. We are all responsible for a stable and working Instana. But if anything breaks, then the owner-team is +# the best place to start looking for help. +# Ownership does NOT mean, that the owner-team has ownership over all the code that this component is using. It might +# well be, that a component serves different purposes (and teams). But if in doubt, the owner-team at least knows whom +# (=which other team or person) to ask for advice. + +* @instana/eng-eum \ No newline at end of file diff --git a/contributing.md b/contributing.md index c3df8b9..02e6197 100644 --- a/contributing.md +++ b/contributing.md @@ -1,15 +1,27 @@ # Contributing +## How to Contribute + This is an open source project, and we appreciate your help! -In order to clarify the intellectual property license granted with contributions from any person or entity, a Contributor License Agreement ("CLA") must be on file that has been signed by each contributor, indicating agreement to the license terms below. This license is for your protection as a contributor as well as the protection of Instana and its customers; it does not change your rights to use your own contributions for any other purpose. +Each source file must include this license header: + +``` +/* + * (c) Copyright IBM Corp. 2024 + */ +``` + +Furthermore you must include a sign-off statement in the commit message. -Please print, fill out, and sign the contributor license agreement. Once completed, please scan the document as a PDF file and email to the following email address: bastian.krol@instana.com. +> Signed-off-by: John Doe -When contributing to this repository, please first discuss the change you wish to make via issue, -email, or any other method with the owners of this repository before making a change. +### Please note that in the case of the below-mentioned scenarios, follow the specified steps: +- **Proposing New Features**: Vist the ideas portal for [Cloud Management and AIOps](https://automation-management.ideas.ibm.com/?project=INSTANA) and post your idea to get feedback from IBM. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base. +- **Raising a Bug**: Please visit [IBM Support](https://www.ibm.com/mysupport/s/?language=en_US) and open a case to get help from our experts. +- **Merge Approval**: The codeowners use LGTM (Looks Good To Me) in comments on the code review to indicate acceptance. A change requires LGTMs from two of the members. Request review from @instana/eng-eum for approvals. -Please note we have a code of conduct, please follow it in all your interactions with the project. +Thank you for your interest in the Instana iOS project! ## Pull Request Process