microsoft
/
electionguard-api-python
зеркало из https://github.com/microsoft/electionguard-api-python.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

✨ Adjust Contributing and Update Templates

This commit is contained in:
Keith Fung 2021-09-20 15:22:03 -04:00
Родитель 8f3dbe65e6
Коммит 3c9154b091
8 изменённых файлов: 134 добавлений и 110 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

26
.github/ISSUE_TEMPLATE/bug_report.md поставляемый
Просмотреть файл

@ -1,26 +0,0 @@
---
name: "\U0001F41B Bug Report"
about: "If something isn't working as expected"
title: ''
labels: 'i: bug, i: needs triage'
assignees: ''
---
## Bug Report
**Current Behavior**
A clear and concise description of the behavior.
**Expected behavior/code**
A clear and concise description of what you expected to happen (or code).
**Environment**
- OS: [e.g. OSX 10.13.4, Windows 10]
- Version: [e.g. 1.0.1]
**Possible Solution**
<!--- Only if you have suggestions on a fix for the bug -->
**Additional context/Screenshots**
Add any other context about the problem here. If applicable, add screenshots to help explain.

55
.github/ISSUE_TEMPLATE/bug_report.yml поставляемый Normal file
Просмотреть файл

@ -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

8
.github/ISSUE_TEMPLATE/config.yml поставляемый Normal file
Просмотреть файл

@ -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.

35
.github/ISSUE_TEMPLATE/enhancement.yml поставляемый Normal file
Просмотреть файл

@ -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

23
.github/ISSUE_TEMPLATE/feature_request.md поставляемый
Просмотреть файл

@ -1,23 +0,0 @@
---
name: "\U0001F680 Feature Request"
about: "I have a suggestion (and may want to implement it)!"
title: ''
labels: 'i: enhancement, i: needs triage'
assignees: ''
---
## Feature Request
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I have an issue when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen. Add any considered drawbacks.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Teachability, Documentation, Adoption, Migration Strategy**
If you can, explain how users will be able to use this and possibly write out details for the docs.
Maybe a screenshot or design?

21
.github/ISSUE_TEMPLATE/generic_issue.md поставляемый
Просмотреть файл

@ -1,21 +0,0 @@
---
name: "\U000026A0 Generic Issue"
about: Report a generic issue that isn't a bug or feature
title: ''
labels: 'i: needs triage'
assignees: ''
---
## Generic Issue
- [ ] Ensure this issue is not a bug report or feature request
**Description**
A clear and concise description of the issue.
**Possible Solution**
<!--- Only if you have suggestions for the issue -->
**Additional context/Screenshots**
Add any other context about the problem here. If applicable, add screenshots to help explain.

37
.github/pull_request_template.md поставляемый
Просмотреть файл

@ -1,25 +1,12 @@
### 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.*
### Checklist
🚨Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
- [ ] 🤔 **CONSIDER** adding a unit test if your PR resolves an issue.
- [ ] ✅ **DO** check open PR's to avoid duplicates.
- [ ] ✅ **DO** keep pull requests small so they can be easily reviewed.
- [ ] ✅ **DO** build locally before pushing.
- [ ] ✅ **DO** make sure tests pass.
- [ ] ✅ **DO** make sure any new changes are documented.
- [ ] ✅ **DO** make sure not to introduce any compiler warnings.
- [ ] ❌**AVOID** breaking the continuous integration build.
- [ ] ❌**AVOID** making significant changes to the overall architecture.
💔Thank you!
[//]: # (🚨 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.*

39
CONTRIBUTING.md
Просмотреть файл

@ -1,18 +1,27 @@
# Contributing
## 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.
This project welcomes contributions and suggestions. Before you get started, you should read the [readme](README.md).
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.
- 🤔 **CONSIDER** adding a unit test if your PR resolves an issue.
- ✅ **DO** check open PR's to avoid duplicates.
- ✅ **DO** keep pull requests small so they can be easily reviewed.
- ✅ **DO** build locally before pushing.
- ✅ **DO** make sure tests pass.
- ✅ **DO** make sure any new changes are documented.
- ✅ **DO** make sure not to introduce any compiler warnings.
- ❌**AVOID** breaking the continuous integration build.
- ❌**AVOID** making significant changes to the overall architecture.
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.
### 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.