Skip to content
This repository has been archived by the owner on Jan 19, 2019. It is now read-only.

[DOCS] Add contributing to README, and disable vscode autoformat #192

Merged
merged 4 commits into from
Nov 28, 2018

Conversation

bradzacher
Copy link
Owner

@bradzacher bradzacher commented Nov 28, 2018

The vscode autoformatter is completely at odds with prettier, so if you don't have the prettier extension installed, you end up with wild changes.

Additionally if you've got both the beautify and prettier extensions installed, it can cause some serious issues.

Forcing it to be on will probably cause a lot of headaches to anyone trying to contribute unless they get their environment setup perfectly (sorry @weirdpattern for earlier!!)

Copy link
Collaborator

@weirdpattern weirdpattern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor things... but need to be addressed before merging...

.editorconfig Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@weirdpattern
Copy link
Collaborator

One more thing, now that I've merged #186, you might want to add a new rule to the .gitignore file... I'm excluding everything in the .vscode except for specific files (currently just the settings.json).

I'm OK with inverting the rule to exclude specific files instead... whatever makes it easier to understand...

@weirdpattern
Copy link
Collaborator

I just thought of something else... what about moving the contributing section from the README.md to its own CONTRIBUTING.md file? it seems to be a common practice and is even suggested in the insights/community tab

…mating

The vscode autoformatter is completely at odds with prettier, so if you don't have the prettier extension installed, you end up with wild changes.
it is too much to explain installing the extensions, and adding the config, and disabling the beautify extension...
@bradzacher
Copy link
Owner Author

Man github handles rebases weirdly..

I just:

  • Moved to separate CONTRIBUTING.md
  • Adjusted yarn test/precommit/travis so they match the docs better.
    • yarn test only runs the tests
    • precommit / travis both now run the lint, format, test and docs checks

Copy link
Collaborator

@weirdpattern weirdpattern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants