doc(): contributing guide and code of conduct addition

* doc(): adding contributing guide and code of conduct Signed-off-by: Puran Adhikari <[email protected]> * doc(): removing unwanted changes Signed-off-by: Puran Adhikari <[email protected]> * doc(): adding contributing guide and code of conduct Signed-off-by: Puran Adhikari <[email protected]> * doc(): removing unwanted changes Signed-off-by: Puran Adhikari <[email protected]> * doc(): maintainers modification Signed-off-by: Puran Adhikari <[email protected]> * Update AUTHORS * doc(): maintainer title changes Signed-off-by: Puran Adhikari <[email protected]> --------- Signed-off-by: Puran Adhikari <[email protected]> Co-authored-by: Md Imran <[email protected]>
kubeslice · Sep 19, 2023 · c459fb6 · c459fb6
1 parent 8a0ab6f
commit c459fb6
Show file tree

Hide file tree

Showing 6 changed files with 367 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/BUG.yaml b/.github/ISSUE_TEMPLATE/BUG.yaml
@@ -0,0 +1,87 @@
+name: "🐛 Bug Report"
+description: "Submit a bug report to help us improve"
+title: "Bug: "
+labels: [bug]
+assignees: ["narmidm","puranadhikari","priyank-upadhyay","richiesebastian"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out our bug report form 🙏
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: "📜 Description"
+      description: "A clear and concise description of what the bug is."
+      placeholder: "It bugs out when ..."
+  - type: textarea
+    id: steps-to-reproduce
+    validations:
+      required: true
+    attributes:
+      label: "👟 Reproduction steps"
+      description: "How do you trigger this bug? Please walk us through it step by step."
+      placeholder: "1. When I ..."
+  - type: textarea
+    id: expected-behavior
+    validations:
+      required: true
+    attributes:
+      label: "👍 Expected behavior"
+      description: "What did you think would happen?"
+      placeholder: "It should ..."
+  - type: textarea
+    id: actual-behavior
+    validations:
+      required: true
+    attributes:
+      label: "👎 Actual Behavior"
+      description: "What did actually happen? Add screenshots, if applicable."
+      placeholder: "It actually ..."
+  - type: textarea
+    id: logs
+    attributes:
+      label:  "🐚 Relevant log output"
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: textarea
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software are you running?
+      placeholder: "I used ...."
+  - type: dropdown
+    id: os
+    attributes:
+      label: "🖥️ What operating system are you seeing the problem on?"
+      multiple: true
+      options:
+        - Linux
+        - MacOS
+        - Windows
+  - type: textarea
+    id: solution
+    validations:
+      required: false
+    attributes:
+      label: "✅ Proposed Solution"
+      description: "Any thoughts as to potential solutions or ideas to go about finding one. Please include links to any research."
+      placeholder: "To fix this, I found ..."
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this issue has been raised before?"
+      description: "Have you researched on internet for a similar issue or checked our older issues for a similar bug?"
+      options:
+        - label: "I checked and didn't find any similar issue"
+          required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: I have read the [https://github.com/kubeslice/kubeslice-controller/blob/master/code_of_conduct.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/FEATURE.yaml b/.github/ISSUE_TEMPLATE/FEATURE.yaml
@@ -0,0 +1,57 @@
+name: 🚀 Feature
+description: "Submit a proposal for a new feature"
+title: "Feature: "
+labels: [feature]
+assignees: ["narmidm","puranadhikari","priyank-upadhyay","richiesebastian"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out our feature request form 🙏
+  - type: textarea
+    id: feature-description
+    validations:
+      required: true
+    attributes:
+      label: "🔖 Feature description"
+      description: "A clear and concise description of what the feature is."
+      placeholder: "You should add ..."
+  - type: textarea
+    id: pitch
+    validations:
+      required: true
+    attributes:
+      label: "🎤 Pitch"
+      description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable."
+      placeholder: "In my use-case, ..."
+  - type: textarea
+    id: solution
+    validations:
+      required: true
+    attributes:
+      label: "✌️ Solution"
+      description: "A clear and concise description of what you want to happen."
+      placeholder: "I want this feature to, ..."
+  - type: textarea
+    id: alternative
+    validations:
+      required: false
+    attributes:
+      label: "🔄️ Alternative"
+      description: "A clear and concise description of any alternative solutions or features you've considered."
+      placeholder: "I tried, ..."
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this issue has been raised before?"
+      description: "Have you researched on internet for a similar issue or checked our older issues for a similar bug?"
+      options:
+        - label: "I checked and didn't find similar issue"
+          required: true
+  - type: checkboxes
+    id: read-code-of-conduct
+    attributes:
+      label: "🏢 Have you read the Code of Conduct?"
+      options:
+        - label: "I have read the [Code of Conduct](https://github.com/kubeslice/kubeslice-controller/blob/master/code_of_conduct.md)"
+          required: true
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,34 @@
+# Names should be added to this file as
+#	Name or Organization <email address>
+# The email address is not required for organizations.
+
+# You can update this list using the following command:
+#
+#   $ (head -n10 AUTHORS && git shortlog -se | sed -E 's/^\s+[0-9]+\t//') | tee AUTHORS
+
+# Please keep the list sorted.
+Eric Peterson <[email protected]>
+Kranthi Kumar <[email protected]>
+Kranthi Kumar <[email protected]>
+MD IMRAN <[email protected]>
+Md Imran <[email protected]>
+Nishant Singh <[email protected]>
+Nishant Singh <[email protected]>
+Priyank Upadhyay <[email protected]>
+Priyank Upadhyay <[email protected]>
+Puran Adhikari <[email protected]>
+Puran Adhikari <[email protected]>
+Richie Sebastian <[email protected]>
+Roshani Khairnar <[email protected]>
+bharath-avesha <[email protected]>
+nishantsingh <[email protected]>
+pnavali <[email protected]>
+rahulsawra98 <[email protected]>
+richiesebastian <[email protected]>
+saivenkatesh1909 <[email protected]>
+sany cyrus <[email protected]>
+sany cyrus <[email protected]>
+sany-avesha <[email protected]>
+srinivas-avesha <[email protected]>
+uma-kt <[email protected]>
+veenamj-avesha <[email protected]>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,55 @@
+# Contributing
+
+Guidelines on how to contribute to KubeSlice
+
+There are a number of ways you can contribute to the KubeSlice project. We would like to accept your patches and contributions to the KubeSlice code base. This document provides guidelines on how to contribute to the KubeSlice code base. We require all participants to adhere to the [Code of Conduct](https://github.com/kubeslice/kubeslice-controller/blob/master/code_of_conduct.md).
+
+
+Here are some ways to contribute:
+
+* Contribute to the KubeSlice codebase.
+* Report and triage bugs.
+* Answer questions on KubeSlice discussions forums.
+* Write technical documentation and blog posts, for users and contributors.
+* File Issues.
+* Provide feedback on the codebase and documentation.
+* Submit PRs for small bug fixes.
+
+## Contributor Compliance with Developer Certificate Of Origin (DCO)
+
+We require every contributor to certify that they are legally permitted to contribute to our project. A contributor expresses this by consciously signing their commits, and by this act expressing that they comply with the Developer Certificate Of Origin
+
+A signed commit is a commit where the commit message contains the following content:
+
+`Signed-off-by: John Doe <[email protected]>`
+
+This can be done by adding `--signoff` to your git command line
+
+## Code of Conduct
+Please make sure to read and observe our [Code of Conduct](https://github.com/kubeslice/kubeslice-controller/blob/master/code_of_conduct.md).
+
+## Contributor Workflow
+
+Pull Requests are welcome. In general, we follow the "fork-and-pull" Git workflow that has the following steps:
+
+1. **Fork** the repo on GitHub.
+2. **Clone** the project to your own machine.
+3. **Commit** changes to your own branch.
+4. **Push** your work back up to your fork.
+5. Submit a **Pull request** so that we can review your changes.
+
+NOTE: Be sure to merge the latest from **upstream** before making a pull request!
+
+## Filing Issues
+If you encounter a bug, please file an issue in the Github repository. Please provide as much information as possible to help fix the issue. Please file the issue under the appropriate repo.
+
+
+## Coding Guidelines
+* Follow good [coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments).
+* Write good [commit messages](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).
+
+## Developer Guide
+This guide helps you to get started with developing [kubeslice-controller](https://github.com/kubeslice/kubeslice-controller/blob/master/developer_guide.md).
+
+## License
+Apache License 2.0
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -0,0 +1,7 @@
+# KubeSlice Controller Maintainers 
+The maintainers are generally available in Slack at https://kubernetes.slack.com in channel #kubeslice
+
+Md Imran [email protected]
+Eric Peterson [email protected]
+Prabhu Navali [email protected]
+Richie Sebastian [email protected]
diff --git a/code_of_conduct.md b/code_of_conduct.md
@@ -0,0 +1,127 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness towards other people.
+* Being respectful of differing opinions, viewpoints, and experiences.
+* Giving and gracefully accepting constructive feedback.
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience.
+* Focusing on what is best not just for us as individuals, but for the overall
+  community.
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind.
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment.
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission.
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting.
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[Authors](https://github.com/kubeslice/kubeslice-controller/blob/master/AUTHORSS).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[FAQ]: https://www.contributor-covenant.org/faq