You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
We've been getting bug reports which don't include good repro steps. Unfortunately GitHub doesn't seem to give the ability to give a predefined template for issue reports, which is a real shame, since having a predefined template really helps improve the quality of reports.As a partial step in that direction we can at least add something to CONTRIBUTING.md to explain what we expect minimally.closesdotnet#75
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+30-1Lines changed: 30 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,6 +27,36 @@ We initially solicit contributions for
27
27
28
28
New features are welcome, but be aware that Visual F# is a high-quality programming language with high-quality tools, and we wish to keep it that way. Before embarking on an extensive feature implementation, make a proposal in a GitHub issue or on the[F# Language UserVoice](https://fslang.uservoice.com/) so the community can review and comment on it.
29
29
30
+
###Issues
31
+
32
+
When submitting issues, please use the following guidelines
33
+
34
+
- Suggestions for the F# Language and Core library should be added and reviewed at the[F# Language User Voice](https://fslang.uservoice.com/).
35
+
36
+
- Suggestions for the Visual F# Tools should be added and reviewed at the[Visual Studio F# Tools User Voice](https://visualstudio.uservoice.com/forums/121579-visual-studio/category/30935-languages-f-tools).
37
+
38
+
- New Bug Reports should always give accurate, clear steps for reproducing the bug, and all relevant details about versions, platform, etc. We suggest the following template:
39
+
40
+
Title: <a short, clear title>
41
+
42
+
Description: <adescriptionoftheproblem>
43
+
44
+
Repro Steps: <stepbystepdescription>
45
+
46
+
Expected: <whatisexpected>
47
+
48
+
Actual: <whatyoureallyget>
49
+
50
+
Severity: a description on how bad it is and why - is it blocking?
51
+
52
+
Version: Language, compiler, library, platform version
53
+
54
+
Link: Give a link to a ZIP, log files or other files if needed
55
+
56
+
Likely Cause: Link to the place in the code where things are likely going wrong, if possible
57
+
58
+
Workaround: List any known workarounds
59
+
30
60
###CLA
31
61
32
62
Contributors are required to sign a[Contribution License Agreement](https://cla.msopentech.com/) (CLA) before any pull requests will be considered. After submitting a request via the provided form, electronically sign the CLA when you receive the email containing the link to the document. This only needs to be done once for each Microsoft OSS project you contribute to.
@@ -66,7 +96,6 @@ Bug fix PRs have the following minimum requirements
66
96
- The code changes must be reasonably minimal and as low-churn, non-intrusive as possible. Cleanup should be done in separate PRs where possible (see above), and fixes should be as small as possible.
67
97
- Thorough test cases must be included in the PR (unless tests already exist for a failing case). PRs without matching tests will be closed with a polite request to please add the tests. However, if you need help adding tests, please note this in the description of the change and people will guide you through where to add the tests.
68
98
69
-
70
99
###Language Evolution
71
100
72
101
We are committed to carefully managing the evolution of the F# language.