π. Adjust Contributing and Add Templates
This commit is contained in:
Π ΠΎΠ΄ΠΈΡΠ΅Π»Ρ
7ce17ceb35
ΠΠΎΠΌΠΌΠΈΡ
6c26b03a3b
|
@ -0,0 +1,55 @@
|
|||
name: π Bug
|
||||
description: Submit a bug if something isn't working as expected.
|
||||
title: "π <title>"
|
||||
labels: [bug, triage]
|
||||
body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Is there an existing issue for this?
|
||||
description: Please search to see if an issue already exists for the bug you encountered.
|
||||
options:
|
||||
- label: I have searched the existing issues
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
description: A concise description of what you're experiencing.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A concise description of what you expected to happen.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps To Reproduce
|
||||
description: Steps to reproduce the behavior.
|
||||
placeholder: |
|
||||
1. In this environment...
|
||||
2. With this config...
|
||||
3. Run '...'
|
||||
4. See error...
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment
|
||||
description: |
|
||||
examples:
|
||||
- **OS**: Ubuntu 20.04
|
||||
value: |
|
||||
- OS:
|
||||
render: markdown
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Anything else?
|
||||
description: |
|
||||
Links? References? Screenshots? Possible Solution? Anything that will give us more context about the issue you are encountering!
|
||||
|
||||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
|
||||
validations:
|
||||
required: false
|
|
@ -0,0 +1,8 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Discussions
|
||||
url: https://github.com/microsoft/electionguard/discussions
|
||||
about: Discuss suggestions and new enhancements here.
|
||||
- name: ElectionGuard Info
|
||||
url: https://https://www.electionguard.vote/
|
||||
about: Learn more about ElectionGuard or email the team.
|
|
@ -0,0 +1,35 @@
|
|||
name: β¨ Enhancement
|
||||
description: Suggest an enhancement or an improvement.
|
||||
title: "β¨ <title>"
|
||||
labels: [enhancement, triage]
|
||||
body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Is there an existing issue for this?
|
||||
description: Please search to see if an issue already exists for the suggestion.
|
||||
options:
|
||||
- label: I have searched the existing issues
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Suggestion
|
||||
description: Tell us how we could improve ElectionGuard.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Possible Implementation
|
||||
description: Not obligatory, but ideas as to the implementation of the suggestion.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Anything else?
|
||||
description: |
|
||||
What are you trying to accomplish?
|
||||
|
||||
Links? References? Anything that will give us more context about the suggestion!
|
||||
|
||||
Tip: You can attach images by clicking this area to highlight it and then dragging files in.
|
||||
validations:
|
||||
required: false
|
|
@ -0,0 +1,12 @@
|
|||
[//]: # (π¨ Please review the CONTRIBUTING.md in this repository. πThank you!)
|
||||
|
||||
### Issue
|
||||
*Link your PR to an issue*
|
||||
|
||||
Fixes #___
|
||||
|
||||
### Description
|
||||
*Please describe your pull request.*
|
||||
|
||||
### Testing
|
||||
*Describe the best way to test or validate your PR.*
|
|
@ -1,6 +1,6 @@
|
|||
## Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Before you get started, you should read the [readme](README.md) and [the design and architecture notes](docs/Design_and_Architecture.md), which describe design & architecture goals of the code and tools & techniques used.
|
||||
This project welcomes contributions and suggestions. Before you get started, you should read the [readme](README.md).
|
||||
|
||||
- π€ **CONSIDER** adding a unit test if your PR resolves an issue.
|
||||
- β
**DO** check open PR's to avoid duplicates.
|
||||
|
@ -12,8 +12,16 @@ This project welcomes contributions and suggestions. Before you get started, you
|
|||
- β**AVOID** breaking the continuous integration build.
|
||||
- β**AVOID** making significant changes to the overall architecture.
|
||||
|
||||
### Creating a Pull Request
|
||||
|
||||
All pull requests should have an accompanying issue. Create one if there is not one matching your code. The code will be checked by continuous integration. Once this CI passes, the code will be reviewed, ideally approved, then merged.
|
||||
|
||||
### CLA
|
||||
|
||||
Open source contributions require you to agree to a standard Microsoft Contributor License Agreement (CLA) declaring that you 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 repos using our CLA.
|
||||
|
||||
### Code of Conduct
|
||||
|
||||
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.
|
||||
|
|
ΠΠ°Π³ΡΡΠ·ΠΊΠ°β¦
Π‘ΡΡΠ»ΠΊΠ° Π² Π½ΠΎΠ²ΠΎΠΉ Π·Π°Π΄Π°ΡΠ΅