|
| 1 | +##Contribution Guidelines |
| 2 | + |
| 3 | +The Visual F# team is proud to be a contributor to F#, and urge you to join in too. F# users and the F# community are grateful for all contributions to F#. |
| 4 | + |
| 5 | +Besides this overview, we recommend ["Becoming a contributor"](http://mrange.wordpress.com/2014/12/11/becoming-an-fsharp-contributor/), a community blog post by Mårten Rånge. |
| 6 | + |
| 7 | +###Getting Started |
| 8 | + |
| 9 | +- Install required software |
| 10 | +- Clone the repo |
| 11 | + - `git clone https://github.com/microsoft/visualfsharp.git` |
| 12 | +- How to build |
| 13 | +- How to run tests |
| 14 | + |
| 15 | +###What to Contribute? |
| 16 | + |
| 17 | +There are several important ways that you can contribute. We are especially grateful for early feedback on in-development features, bug reports with repro steps, bug fixes with regression test cases, cross-platform expertise and changes, documentation updates, feature tests, suggestions, comments, and ideas. |
| 18 | + |
| 19 | +We initially solicit contributions for |
| 20 | + |
| 21 | +- compiler optimizations |
| 22 | +- compiler performance improvements |
| 23 | +- code generation improvements |
| 24 | +- bug fixes (see the [issues list](https://github.com/microsoft/visualfsharp/issues)) |
| 25 | +- library improvements |
| 26 | +- F# language and library features |
| 27 | + |
| 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 | + |
| 30 | +###CLA |
| 31 | + |
| 32 | +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. |
| 33 | + |
| 34 | +###Quality and Testing |
| 35 | + |
| 36 | +Contributions to this repository will be rigorously policed for quality. |
| 37 | + |
| 38 | +All code submissions should be submitted with regression test cases, and will be subject to peer review by the community and Microsoft. The bar for contributions will be high. This will result in a higher-quality, more stable product. |
| 39 | + |
| 40 | +- We expect contributors to be actively involved in quality assurance. |
| 41 | +- We expect contributors to be actively involved in quality assurance. |
| 42 | +- Partial, incomplete, or poorly-tested contributions will not be accepted. |
| 43 | +- Contributions may be put on hold according to stability, testing, and design-coherence requirements. |
| 44 | + |
| 45 | +###Language Evolution |
| 46 | + |
| 47 | +We are committed to carefully managing the evolution of the F# language. |
| 48 | + |
| 49 | +We actively solicit contributions related to the F# language design, but the process for handling these differs substantially from other kinds of contributions. Significant language and library change should be suggested and reviewed at the [F# Language User Voice](https://fslang.uservoice.com/) site. |
| 50 | + |
| 51 | +###Coding guidelines |
| 52 | + |
| 53 | +Although there is currently no strict set of coding or style guidelines, use common sense when contributing code - make an effort to use a similar style to nearby existing code. If you have a passion for helping us develop a set of coding guidelines that we can roll out and apply within this project, get involved and start a discussion issue. |
0 commit comments