New Issue/PR Templates & New Contributors Guide (#67)
* New Issue/PR Templates & New Contributors Guide * linting * * added new contibutor guidelines * updated PR template * updated config yaml * updated feature request issue template * removed old feature request template * included proposed changes * updated contribunting first paragraph * included suggested changes
This commit is contained in:
Marvin Buss
GitHub
Родитель
ef8c5fc335
Коммит
72c0355eb7
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
name: "Bug report \U0001F41B"
|
||||
about: Report errors or unexpected behaviour
|
||||
title: 'Bug Report'
|
||||
labels: bug
|
||||
assignees: 'marvinbuss'
|
||||
|
||||
---
|
||||
|
||||
<!-- Please read our Rules of Conduct: https://opensource.microsoft.com/codeofconduct/ -->
|
||||
<!-- Please search existing issues to avoid creating duplicates. -->
|
||||
|
||||
**Describe the bug**
|
||||
|
||||
|
||||
**Steps to reproduce**
|
||||
|
||||
1.
|
||||
2.
|
||||
|
||||
**Screenshots**
|
||||
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
name: "Bug report 🐛"
|
||||
description: Report errors or unexpected behavior
|
||||
title: "Bug Report: "
|
||||
labels:
|
||||
- bug
|
||||
- backlog
|
||||
assignees: "marvinbuss"
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this report! Before submitting, please make sure to [search through existing issues](https://github.com/Azure/data-product-streaming/issues) and [check the Known Issues section](/docs/EnterpriseScaleAnalytics-KnownIssues.md).
|
||||
|
||||
- type: dropdown
|
||||
id: deployment
|
||||
attributes:
|
||||
label: Deployment Mode
|
||||
description: How was the deployment executed?
|
||||
multiple: false
|
||||
options:
|
||||
- Deploy To Azure
|
||||
- Azure DevOps
|
||||
- GitHub Actions
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
placeholder: Please share with us the step(s) required to reproduce the bug.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: error
|
||||
attributes:
|
||||
label: Error Message
|
||||
description: If possible, please share the error message that you received.
|
||||
placeholder: Error Messages
|
||||
render: json
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots
|
||||
description: If possible, please include screenshots and paste them into the markdown editor below.
|
||||
placeholder: Screenshots
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: code_of_conduct
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: The Code of Conduct helps create a safe space for everyone. We require that everyone must abide by it.
|
||||
options:
|
||||
- label: I agree to follow this project's [Code of Conduct](/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: "Thanks for completing this form!"
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
name: "Documentation Issue 📚"
|
||||
description: Report issues in our documentation
|
||||
title: " "
|
||||
labels:
|
||||
- documentation
|
||||
- backlog
|
||||
assignees: " "
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this report! Before submitting, please make sure to [search through existing issues](https://github.com/Azure/data-product-streaming/issues) and [check the Known Issues section](/docs/EnterpriseScaleAnalytics-KnownIssues.md).
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Documentation Issue
|
||||
placeholder: Please share the name of the document along with supporting points on why it requires an amendment.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: code_of_conduct
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: The Code of Conduct helps create a safe space for everyone. We require that everyone must abide by it.
|
||||
options:
|
||||
- label: I agree to follow this project's [Code of Conduct](/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: "Thanks for completing this form!"
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
name: "Feature request \U0001F680"
|
||||
about: Suggest an idea for this project
|
||||
title: 'Feature Request'
|
||||
labels: feature
|
||||
assignees: 'marvinbuss'
|
||||
|
||||
---
|
||||
|
||||
<!-- Please read our Rules of Conduct: https://opensource.microsoft.com/codeofconduct/ -->
|
||||
<!-- Please search existing issues to avoid creating duplicates. -->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
name: "Feature Request & Ideas 🚀"
|
||||
description: Suggest a new feature or improvement (this does not mean you have to implement it)
|
||||
title: "Feature Request: "
|
||||
labels:
|
||||
- feature
|
||||
- backlog
|
||||
assignees: "marvinbuss"
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this report! Before submitting, please make sure to [search through existing issues](https://github.com/Azure/data-product-streaming/issues) and [check the Known Issues section](/docs/EnterpriseScaleAnalytics-KnownIssues.md).
|
||||
|
||||
- type: textarea
|
||||
id: feature_description
|
||||
attributes:
|
||||
label: Feature or Idea - What?
|
||||
placeholder: Briefly describe what the new feature, idea or enhancement entails.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: feature_reason
|
||||
attributes:
|
||||
label: Feature or Idea - Why?
|
||||
placeholder: Briefly describe why the new feature, idea or enhancement is required and what outcome you are trying to achieve.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: code_of_conduct
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: The Code of Conduct helps create a safe space for everyone. We require that everyone must abide by it.
|
||||
options:
|
||||
- label: I agree to follow this project's [Code of Conduct](/CODE_OF_CONDUCT.md)
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: "Thanks for completing this form!"
|
||||
|
|
@ -1 +1,6 @@
|
|||
blank_issues_enabled: true
|
||||
blank_issues_enabled: true
|
||||
|
||||
contact_links:
|
||||
- name: Microsoft Security Response Center 🔐
|
||||
url: https://msrc.microsoft.com/create-report
|
||||
about: Please report security vulnerabilities here.
|
||||
|
|
@ -1,7 +1,16 @@
|
|||
<!-- Thank you for submitting a Pull Request. Please:
|
||||
* Associate an issue with the Pull Request.
|
||||
* Ensure that the code is up-to-date with the `main` branch.
|
||||
* Include a description of the proposed changes.
|
||||
-->
|
||||
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
|
||||
## Summary of the Pull Request
|
||||
|
||||
**This PR fixes**
|
||||
<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? -->
|
||||
## References
|
||||
|
||||
<!-- Please review the items on the PR checklist before submitting-->
|
||||
## PR Checklist
|
||||
* [ ] Closes Issue #xxx
|
||||
* [ ] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
|
||||
|
||||
<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
|
||||
## Detailed Description of the Pull Request / Additional comments
|
||||
|
||||
<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
|
||||
## Validation Steps Performed
|
||||
|
|
|
|||
|
|
@ -0,0 +1,99 @@
|
|||
# Contributor's Guide
|
||||
|
||||
This project welcomes community contributions. The contributions could be [Issues](#issue-reports) or [Pull Requests](#pull-requests), any form of contribution is welome. Please note that by participating in this project, you agree to abide by the [Code of Conduct](/CODE_OF_CONDUCT.md) and the terms of the [CLA](#cla).
|
||||
|
||||
> If you have a question, have discovered an issue or perhaps you would like to propose an enhancement or idea, please file an issue report **BEFORE** commencing work on it.
|
||||
|
||||
## Open Development Workflow
|
||||
|
||||
The Customer Architecture Team (CAT) is very active in this GitHub repository and carries out all the development work in the public. New issues, ideas or feature requests are filed in the repo and fixes/new implementations are implemented through pull requests that are linked to their respective issues. Code reviews can be followed as well to learn about the principles which the team follows in building and maintaining artefacts related to this repository..
|
||||
|
||||
All the work of the CAT team is executed in the public to ensure a high degree of transparency for the community. In addition, it allows the community to more easily contribute to the projects because everyone is aware of new features that are commited or issues that are existing within the projects.
|
||||
|
||||
Working in the public also ensures a high-quality bar and allows open discussions about the why and how of new developments.
|
||||
|
||||
## Issue Reports
|
||||
|
||||
We are encouraging you to select between a [Bug Report](#bug-report), a [Feature Request](#feature-request), a [Documentation Issue](#documentation-issue) and a [Vulnerability Report](#vulnerability-report) when opening a new Issue in this repository. Please provide all the required information for the respective issue reports and make sure you accept the [Code of Conduct](/CODE_OF_CONDUCT.md).
|
||||
|
||||
Before submitting a report, please search through the open and closed issues in this repository as well as through the [Known Issues](/docs/EnterpriseScaleAnalytics-KnownIssues.md). If a similar issue already exists, please upvote the existint issue comment(s) or leave a comment instead of opening a new issue. This helps us reduce the number issues and also simplifies the management on our side. Only if no existing item describes your issue report we encourage you to file a new one.
|
||||
|
||||
### Bug Report
|
||||
|
||||
Submit new bug reports using the "Bug Report" issue template. When submitting a bug report, please try to be as specific as possible by including a detailed description of how to reproduce the issue and also share any error messages or screenshots if possible. This will help us throubleshoot the bug/issue and apply fixes in a timely fashion.
|
||||
|
||||
### Feature Request
|
||||
|
||||
New feature requests and ideas must be submitted using the "Feature Request & Ideas" issue template. Please be specific about the "What?" and "Why?" by sharing what the feature entails and what the benefits of including this feature will be.
|
||||
|
||||
### Documentation Issue
|
||||
|
||||
Documentation issues should be submitted using the "Documentation Issue" issue template. Please be specific about which document needs to be updated and why.
|
||||
|
||||
### Vulnerability Report
|
||||
|
||||
Please read through the [security policy](/SECURITY.md) before submitting a vulnerability report. After reading through the guidelines, you can use the "Microsoft Security Response Center" to submit a new vulnerability.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
We encourage users to not only submit issues but also start contributing to the repository by opening pull requests to fix issues that were submitted previously. Please always submit an issue before opening a pull request to make the team aware of the requested change and to be able to discuss the possible implications of proposed changes. Some issues or features may be quick and simple to describe and understand while others may require a detailed spec to agree on changes.
|
||||
|
||||
### Getting Started
|
||||
|
||||
Before starting to develop, you should fork this repo (see [this forking guide](https://guides.github.com/activities/forking/) for more information). Next, you should checkout the repo locally with `git clone git@github.com:{your_username}/{repo_name}.git`.
|
||||
|
||||
### Tooling
|
||||
|
||||
To help you contribute to the project more easily, you can find a [development container definition](/.devcontainer) in the `.devcontainer` folder of this repository. The development container has all the necessary tools and VS Code extensions enabled to provide you a curated development environment in which you can start developing without requiring you to install VS Code extensions on your local machine. Dev containers can be used via the [VS Code Remote - Containers](https://aka.ms/vscode-remote/download/containers) extension or [GitHub Codespaces](https://github.com/features/codespaces).
|
||||
|
||||
If you would like to work inside your local environment, you should install the following tools locally:
|
||||
|
||||
- PowerShell Core
|
||||
- Azure CLI
|
||||
- Git
|
||||
- VS Code
|
||||
|
||||
In addition, we recommend you to install the following VS Code extensions:
|
||||
|
||||
- Azure Account
|
||||
- Azure CLI Tools
|
||||
- Azure Resource Manager (ARM) Tools
|
||||
- Bicep
|
||||
- PowerShell`
|
||||
|
||||
### Development
|
||||
|
||||
When working on the Infrastructure as Code (IaC) definitions in this repository, please be aware that you must always change the bicep code. The ARM templates, which you can also find i this repository, are just auto generated by building the Bicep definitions.
|
||||
|
||||
Therefore, you should follow the following development cycle:
|
||||
|
||||
1. Make changes to the Bicep code.
|
||||
2. Build the new Bicep project by running `az bicep build -f main.bicep`.
|
||||
3. Commit all files to your branch.
|
||||
4. Submit your pull request.
|
||||
|
||||
### Pull Request Information
|
||||
|
||||
Before opening a pull request, ensure that an issue has been created to track the feature enhancement or bug that is being fixed. In the PR description, make sure you are linking the issue that this PR is about to close. To avoid multiple contributors working on the same issue, please add a comment to the issue that your are planning to work on.
|
||||
|
||||
If the pull request is still work in progress, please open the pull request in draft mode.
|
||||
|
||||
### Testing
|
||||
|
||||
Testing is a key component in the development workflow. We run automated tests on all pull requests to enforce strict linting rules and also make sure that changes introduced to the IaC are not introducing code degredation.
|
||||
|
||||
### Code Review
|
||||
|
||||
If you want the team to review the changes, mark the pull request as "Ready for review". The team will get back to you and approve the PR, provide comments or request changes if necessary. The review process may take a few cycles in order to ensure that all content is of high quality and well structured.
|
||||
|
||||
### Merge
|
||||
|
||||
After the pull request has been reviewed and approved, the feature branch will be merged into the main branch and automatically closed and deleted.
|
||||
|
||||
## CLA
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
|
||||
|
||||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
|
@ -50,8 +50,4 @@ To deploy the Data Product into your Data Landing Zone, please follow the step-b
|
|||
|
||||
## Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
|
||||
|
||||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
Please review the [Contributor's Guide](./CONTRIBUTING.md) for more information on how to contribute to this project via Issue Reports and Pull Requests.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче