зеркало из https://github.com/dotnet/winforms.git
Update docs pertaining to feature requests (#3042)
This commit is contained in:
Igor Velikorossov
GitHub
Родитель
a09958989b
Коммит
1e0ac96b26
|
|
@ -14,22 +14,25 @@ assignees: ''
|
|||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
-->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
**Describe the solution you'd like and alternatives you've considered**
|
||||
<!--
|
||||
A clear and concise description of what you want to happen.
|
||||
Add any other context or screenshots about the feature request here.
|
||||
A clear and concise description of what you want to happen. This includes:
|
||||
- Description of what API need to be added or changed.
|
||||
- Code that shows the surface area of the API.
|
||||
- Code that shows real world scenarios, and how they would otherwise be handled.
|
||||
- Details showing the usage/consumption of the proposed new API, and alternatives (e.g. not having this API).
|
||||
- Any other context or screenshots about the feature request here.
|
||||
|
||||
:exclamation: Read https://github.com/dotnet/winforms/blob/master/Documentation/issue-guide.md for more details
|
||||
|
||||
-->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
<!--
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
-->
|
||||
|
||||
**Will this feature affect UI controls?**
|
||||
<!--
|
||||
Yes / No
|
||||
|
||||
If yes, please describe the following:
|
||||
If yes, describe the following:
|
||||
|
||||
- Will VS Designer need to support the feature? If yes, describe how you expect it to funсtion.
|
||||
- What impact will it have on accessibility?
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ The [Issue Guide](issue-guide.md) describes our approach to using GitHub issues.
|
|||
|
||||
## Machine Setup
|
||||
|
||||
Follow the [Building CoreFX on Windows][corefx-windows-instructions] instructions. In particular, [Visual Studio 2019 Preview][vs-preview] is required to develop on .NET Core.
|
||||
Follow the [.NET Runtime][net-runtime-instructions] instructions.
|
||||
|
||||
Windows Forms requires the following workloads and components be selected when installing Visual Studio:
|
||||
|
||||
|
|
@ -21,28 +21,25 @@ Windows Forms requires the following workloads and components be selected when i
|
|||
|
||||
We use the following workflow for building as well as testing features and fixes.
|
||||
|
||||
You first need to [Fork][fork] and [Clone][clone] this WinForms repository. This is a one-time task.
|
||||
You first need to [fork][fork] and [clone][clone] this Windows Forms repository. This is a one-time task.
|
||||
|
||||
1. [Build](building.md) the repository.
|
||||
|
||||
2. [Debug](debugging.md) the change, as needed.
|
||||
|
||||
3. [Test](testing.md) the change, to validate quality.
|
||||
|
||||
## More Information
|
||||
|
||||
* [Git commands and workflow][git-commands]
|
||||
* [Coding guidelines][corefx-coding-guidelines]
|
||||
* [up-for-grabs WinForms issues][up-for-grabs]
|
||||
* [up-for-grabs Windows Forms issues][up-for-grabs]
|
||||
* [easy WinForms issues][easy]
|
||||
|
||||
[comment]: <> (URI Links)
|
||||
|
||||
[corefx-windows-instructions]: https://github.com/dotnet/corefx/blob/master/Documentation/building/windows-instructions.md
|
||||
[vs-preview]: https://visualstudio.microsoft.com/vs/preview/
|
||||
[net-runtime-instructions]: https://github.com/dotnet/runtime/tree/master/docs
|
||||
[fork]: https://github.com/dotnet/corefx/wiki/Checking-out-the-code-repository#fork-the-repository
|
||||
[clone]: https://github.com/dotnet/corefx/wiki/Checking-out-the-code-repository#clone-the-repository
|
||||
[git-commands]: https://github.com/dotnet/corefx/wiki/git-reference
|
||||
[corefx-coding-guidelines]: https://github.com/dotnet/corefx/tree/master/Documentation#coding-guidelines
|
||||
[corefx-coding-guidelines]: https://github.com/dotnet/runtime/tree/master/docs/coding-guidelines
|
||||
[up-for-grabs]: https://github.com/dotnet/winforms/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs
|
||||
[easy]: https://github.com/dotnet/winforms/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Aeasy
|
||||
|
|
|
|||
|
|
@ -6,11 +6,11 @@ It may be as simple as a small product or test bug or as large as the work track
|
|||
|
||||
We will keep issues open even if the WinForms team internally has no plans to address them in an upcoming release, as long as we believe they are in line with our direction.
|
||||
|
||||
## How to file issues
|
||||
# How to file issues
|
||||
|
||||
You can help us streamline our response time to your feedback and ideas by filing high-quality reports.
|
||||
|
||||
## Known Issues
|
||||
### Known Issues
|
||||
|
||||
If you encounter an issue using the latest .NET Core 3.1 SDK, please:
|
||||
|
||||
|
|
@ -18,32 +18,28 @@ If you encounter an issue using the latest .NET Core 3.1 SDK, please:
|
|||
1. Explore [this repositories issues][winforms-issues], and then
|
||||
1. [Open a new issue][new-issue] if there is none.
|
||||
|
||||
### High-quality bug reports
|
||||
### Bug reports
|
||||
|
||||
In general, try to be specific. Get straight to the main point. Leave additional details, options, and alternatives to the end (hint: separate them visually). Don't write long bug reports, unless you have to.
|
||||
|
||||
* Include a minimal reproduction (repro) in your bug if at all possible (chop off dependencies, remove as much code as possible). If it is not possible, say why.
|
||||
* Note: Yes, it may take some time to minimize a repro from your larger app - but that is exactly what we would do in most cases anyway. Issues with clear, concise reproduction guidelines are easier for us to investigate; such issues will have higher chance of being addressed quickly.
|
||||
* Include a minimal reproduction (repro) in your bug if at all possible (chop off dependencies, remove as much code as possible). If it is not possible, say why.<br />
|
||||
:warning: Note: Yes, it may take some time to minimize a repro from your larger app - but that is exactly what we would do in most cases anyway. Issues with clear, concise reproduction guidelines are easier for us to investigate; such issues will have higher chance of being addressed quickly.
|
||||
* Include call-stacks, symptom descriptions, and differences between actual and expected behaviors.
|
||||
|
||||
### High-quality feature and API suggestions
|
||||
### Feature and API suggestions
|
||||
|
||||
Provide clear description of your suggestion. Explain scenarios in which it would be helpful and why (motivation).
|
||||
Ideally, assume that the reader has minimal knowledge and experience with writing apps/libraries that would benefit from the feature.
|
||||
Assume that the reader has minimal knowledge and experience with writing apps/libraries that would benefit from the feature, so try and write to that audience. Provide clear description of your suggestion, and explain scenarios in which it would be helpful and why (motivation).
|
||||
|
||||
For API suggestions, check [API review process][corefx-api-review-process], especially [example of good API proposals][corefx-api-proposal-ex].
|
||||
Prepare code examples that showcase the need and general usefulness of the proposal. Specifically:
|
||||
* Code that shows the surface area of the API.
|
||||
* Code that shows real world scenarios, and how they would otherwise be handled.
|
||||
* Details showing the usage/consumption of the proposed new package, and alternatives (e.g. not having this be a separate package).
|
||||
|
||||
## Labels
|
||||
:warning: All new API or changes to public API must undergo an API review process. Learn more what the [API review process][api-review-process] entails.
|
||||
|
||||
We use GitHub [labels][labels] on our issues in order to classify them. We have the following categories per issue:
|
||||
|
||||
* **Issue Types**: These labels classify the type of issue. We use the following types:
|
||||
* [api-suggestion]: Issues which would add new APIs (see [API Review process][corefx-api-review-process] for details).
|
||||
* [bug][bug], [enhancement][enhancement], [test-bug][test-bug], [test-enhancement][test-enhancement], [question][question], [documentation][documentation]: See [label description][label-description] for details.
|
||||
* **Other**:
|
||||
* [up-for-grabs][up-for-grabs]: Smaller sections of work which we believe are well scoped. These sorts of issues are a good place to start if you are new. Anyone is free to work on these issues.
|
||||
* [needs-more-info][needs-more-info]: Issues which need more information to be actionable. Usually this will be because we can't reproduce a reported bug. We'll close these issues after a little bit if we haven't gotten actionable information, but we welcome folks who have acquired more information to reopen the issue.
|
||||
* [tenet-compatibility][tenet-compatibility]: Incompatibility between released versions or with WinForms for .NET Framework.
|
||||
Here are few example of a good API proposal:
|
||||
* https://github.com/dotnet/runtime/issues/15725
|
||||
* https://github.com/dotnet/runtime/issues/15725
|
||||
|
||||
|
||||
## Assignee
|
||||
|
|
@ -62,15 +58,10 @@ We can [sort issues by number of up-votes][up-votes], and we will review the top
|
|||
Guidance for triage of issues for Windows Forms team members:
|
||||
|
||||
1. Issue has no **Assignee**, unless someone is working on the issue at the moment.
|
||||
|
||||
1. Use **up-for-grabs** as much as possible, ideally with a quick note about next steps / complexity of the issue.
|
||||
|
||||
1. Set milestone to **Future**, unless you can 95%-commit you can fund the issue in specific milestone.
|
||||
|
||||
1. Each issue has exactly one "*issue type*" label (**bug**, **enhancement**, **api-suggestion**, **test-bug**, **test-enhancement**, **question**, **documentation**, etc.).
|
||||
|
||||
1. Don't be afraid to say no, or close issues — just explain why and be polite.
|
||||
|
||||
1. Don't be afraid to be wrong - just be flexible when new information appears.
|
||||
|
||||
Feel free to use other labels if it helps your triage efforts (for example, **needs-more-info**, **design-discussion**, **tenet-compatibility**, etc.).
|
||||
|
|
@ -89,13 +80,10 @@ Feel free to use other labels if it helps your triage efforts (for example, **ne
|
|||
1. Each issue has exactly one "*issue type*" label (**bug**, **enhancement**, **api-suggestion**, **test-bug**, **test-enhancement**, **question**, **documentation**, etc.).
|
||||
* Don't be afraid to be wrong when deciding 'bug' vs. 'test-bug' (flip a coin if you must). The most useful values for tracking are 'api-*' vs. 'enhancement', 'question', and 'documentation'.
|
||||
|
||||
1. Don't be afraid to say no, or close issues — just explain why and be polite.
|
||||
|
||||
1. Don't be afraid to be wrong - just be flexible when new information appears.
|
||||
# Pull-Request (PR) Guide
|
||||
|
||||
## Pull Request (PR) guidance
|
||||
|
||||
Each PR has to have reviewer approval from at least one WinForms team member who is not author of the change, before it can be merged.
|
||||
Each PR has to have reviewer approval from at least one Windows Forms team member who is not author of the change, before it can be merged.
|
||||
|
||||
|
||||
1. Please don't set any labels on PRs.
|
||||
|
|
@ -113,11 +101,10 @@ Each PR has to have reviewer approval from at least one WinForms team member who
|
|||
|
||||
[comment]: <> (URI Links)
|
||||
|
||||
[.net-core-3.0-known-issues]: https://github.com/dotnet/core/blob/master/release-notes/3.0/preview/3.0.0-preview-known-issues.md
|
||||
|
||||
[winforms-issues]: https://github.com/dotnet/winforms/issues
|
||||
[new-issue]: https://github.com/dotnet/winforms/issues/new/choose
|
||||
[corefx-api-review-process]: https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/api-review-process.md
|
||||
[corefx-api-proposal-ex]: https://github.com/dotnet/corefx/issues/271
|
||||
[api-review-process]: https://github.com/dotnet/runtime/blob/master/docs/project/api-review-process.md
|
||||
[labels]: https://github.com/dotnet/winforms/labels
|
||||
[api-suggestion]: https://github.com/dotnet/winforms/labels/api-suggestion
|
||||
[API Review process]: https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/api-review-process.md
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче