Skip to content

Commit 16e1a35

Browse files
committed
added some text about paths to remove/ignore when merging
1 parent 17b7f20 commit 16e1a35

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,10 @@ plus scripts
226226

227227
## Development Notes
228228

229+
### Submitting Pull Requests
230+
231+
Feel free to send in-progress Pull Requests to ask for clarification or direction for a feature or task.
232+
229233
### Integrating changes from 'visualfsharp'
230234

231235
To integrate latest changes from https://github.com/Microsoft/visualfsharp, use
@@ -234,6 +238,14 @@ git remote add visualfsharp https://github.com/Microsoft/visualfsharp
234238
git pull visualfsharp master
235239
```
236240

241+
There are certain guidelines that need to be followed when integrating changes from upstream:
242+
* this repository does not undergo the QA test process that upstream does, so the `tests/fsharpqa` folder and all files within should be removed when merging
243+
* this repository does not contain any of the Visual Studio tooling or integrations, so the `vsintegration` directory and all files within should be removed when merging
244+
* anything referencing `FSharp.LaunguageService.Compiler` is a Microsoft-internal version of the open FSharp.Compiler.Service repository, and as such should be removed when merging
245+
* Windows-specific `update.cmd` and `runtests.cmd` aren't used in this repository, and so should be removed when merging
246+
* anything that references the `Salsa` testing library is used by Microsoft to test the Visual Studio integrations, and as such should be removed when merging
247+
* the foremost example of the above is the `root/unittests` folder, which contains tests for the Visual Studio integration using Salsa, and as such should be removed when merging
248+
237249
### Continuous Integration Build
238250

239251
A continuous integration build is set up with Travis. See above.

0 commit comments

Comments
 (0)