Skip to content

Commit

Permalink
[EPMDEDP-12421]: chore: Add templates for github issues
Browse files Browse the repository at this point in the history
Change-Id: Idb5c734a0dc9a387657bc94cfbbc2d6b1b51e680
  • Loading branch information
Mykola Serdiuk committed Aug 18, 2023
1 parent 6a6997f commit 81d5037
Show file tree
Hide file tree
Showing 6 changed files with 213 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**

#### What did you do?

<!-- A clear and concise description of the steps you took (or insert a code snippet). -->

#### What did you expect to see?

<!-- A clear and concise description of what you expected to happen (or insert a code snippet). -->

#### What did you see instead? Under which circumstances?

<!-- A clear and concise description of what ACTUALLY happened (or insert a code snippet). -->

**Kubernetes cluster type:**

`$ kubectl version`

<!-- If applicable, insert the output of `kubectl version` here -->

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
24 changes: 24 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Code of Conduct

Our community is built on a foundation of respect, inclusiveness, and openness. We believe that everyone should be able to participate and contribute, regardless of their background or identity.

To ensure a positive experience for all, we have established this Code of Conduct. All members, participants, and contributors are expected to abide by these rules.

## Expectations
- Be respectful of others, their opinions, and their work.
- Avoid demeaning, discriminatory, or harassing behavior and speech.
- Refrain from any form of bullying, trolling, or flaming.
- Use inclusive language and be mindful of the impact your words may have on others.
- Be open to constructive criticism and willing to learn from it.
- Respect the privacy and confidentiality of others.

## Consequences
- Participants who violate the Code of Conduct may be warned, asked to leave the community, or banned at the discretion of the community organizers.
- If you experience any form of harassment, discrimination, or other Code of Conduct violation, please report it to the community organizers.

## Changes to the Code of Conduct
- The Code of Conduct may be updated from time to time to better reflect the needs and expectations of the community.
- All members, participants, and contributors are encouraged to periodically review the Code of Conduct to stay informed of any updates.

## Contact Information
- If you have any questions or concerns about the Code of Conduct, please reach out to the community organizers at [SupportEPMD-EDP@epam.com](mailto:SupportEPMD-EDP@epam.com)
95 changes: 95 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Contributing to EPAM Delivery Platform (EDP)

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to EDP, hosted in the [EPAM Organization](https://github.com/epam) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

#### Table Of Contents

[Code of Conduct](#code-of-conduct)

[How Can I Contribute?](#how-can-i-contribute)
* [Reporting Bugs](#reporting-bugs)
* [Suggesting Enhancements](#suggesting-enhancements)

[Styleguides](#styleguides)
* [Git Commit Messages](#git-commit-messages)

## Code of Conduct

This project and everyone participating in it is governed by the [EDP Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [SupportEPMD-EDP@epam.com](mailto:SupportEPMD-EDP@epam.com).

## How Can I Contribute?

### Reporting Bugs

This section guides you through submitting a bug report for EDP. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating issue, please perform a [cursory search](https://github.com/search?q=repo%3Aepam%2Fedp-install+is%3Aissue&type=issues) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.

When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/epam/edp-install/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster.

> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
#### How Do I Submit A (Good) Bug Report?

Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on repository and provide the following information by filling in [the template](https://github.com/epam/edp-install/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md).

Explain the problem and include additional details to help maintainers reproduce the problem:

* **Use a clear and descriptive title** for the issue to identify the problem.
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started EDP, e.g. which command exactly you used in the terminal, or how you started EDP otherwise. When listing steps, **don't just say what you did, but explain how you did it**.
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
* **Explain which behavior you expected to see instead and why.**
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.

Include details about your configuration and environment:

* **Which version of EDP are you using?**
* **What's the name and version of the cluster you're using**?

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for EDP, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Before creating enhancement suggestions, please perform a [cursory search](https://github.com/search?q=repo%3Aepam%2Fedp-install+is%3Aissue&type=issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/epam/edp-install/.github/blob/master/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed.

#### How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on repository and provide the following information:

* **Use a clear and descriptive title** for the issue to identify the suggestion.
* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
* **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of EDP which the suggestion is related to.
* **Explain why this enhancement would be useful**
* **Which version of EDP are you using?**
* **What's the name and version of the cluster you're using**?
* **Which version of EDP is being integrated with?**

### Pull Requests

The process described here has several goals:

- Maintain EDP quality
- Fix problems that are important to users
- Engage the community in working toward the best possible EDP

Please follow these steps to have your contribution considered by the maintainers:

1. Follow all instructions in [the template](pull_request_template.md)
2. Follow the [styleguides](#styleguides)
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

## Styleguides

### Git Commit Messages

* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
* Limit the first line to 72 characters or less
* Reference issues and pull requests liberally after the first line
9 changes: 9 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

## Supported Versions

The EDP-install project maintains release branches for the three most recent minor releases. Applicable fixes, including security fixes, may be backported to those three release branches, depending on severity and feasibility. Please refer to CHANGELOG.md for details.

## Reporting a Vulnerability

Please report (suspected) security vulnerabilities to SupportEPMD-EDP@epam.com. You will receive a response from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity.
28 changes: 28 additions & 0 deletions pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Pull Request Template

## Description
Please include a summary of the change and why it is needed.

Fixes # (issue)

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

## Checklist:
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes

## Screenshots (if appropriate):

## Additional context
Add any other context or screenshots about the feature request here.

0 comments on commit 81d5037

Please sign in to comment.