docs(contribution): Windows based contributors developer workflow #999
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Modern IDEs support (at last!) LF line endings. This commit ensures that - Every text file is checked out with LF line endings in the working directory (eol=lf) - Every potentially introduced CRLF in a text file will be converted back to LF on staging (* text=auto) cf. https://git-scm.com/docs/gitattributes
- Editorconfig ensures the defined code styles is taken into account - Jest runner helps troubleshoot failing tests
|
@philsturgeon @P0lip In order to have a working Thoughts? |
nulltoken
changed the title
P0lip
changed the title
|
@philsturgeon do you have any concerns or questions? If not, let's merge it. |
philsturgeon
approved these changes
Mar 4, 2020
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Does this PR introduce a breaking change?
Yes
No
Adds recommended vscode extensions
Adds a preconfigured Linux/node12 based development container for troubleshooting purposes
Provides some insights to contributing to Spectral from a Windows based environment
Note: The changes to the
.gitattributesfiles are mostly related to the container based development process where the files will be certainly checked out in a Windows based context then "shared" between the two OSes (and the fact that Linux doesn't like CRLFs at all).