Added instructions for setting options #323
Conversation
|
Thanks for contributing! It looks like CI is failing because Prettier isn't being run on the README.md file. This should happen automatically when you make a commit. Did you run |
README.md
Outdated
| @@ -66,7 +66,15 @@ yarn fix | |||
| ``` | |||
| yarn test | |||
| ``` | |||
| ### Setting up | |||
There was a problem hiding this comment.
This is a bit confusing because the rest of this file is geared towards developers working on this project. If we want to add usage documentation, I think we should either create a new, separate section of the readme or create a new file. This information would ideally be on a real site - I wonder if we could add documentation on the Prettier website once this becomes stable?
There was a problem hiding this comment.
Actually I think adding documentation should be considered and well also contributor guide in the repositories on how to go about Contributing to Prettier. I don't think I have been it anywhere
There was a problem hiding this comment.
By creating another section, do I use wiki pages? for that or I should just leave it for it to be included in the docs?
There was a problem hiding this comment.
That's a really great point about missing a CONTRIBUTING.md document. We should definitely add this!
I think a Wiki Page would be great! @lipis @nickmccurdy What are your thoughts?
There was a problem hiding this comment.
The standard on GitHub is putting development information in CONTRIBUTING.md, it will even notify users about the file if they open a pull request for the first time. It seems like our development and help sections should be moved to contributing, while installation and this new setting up section should be in the readme. While we're at it, it would be nice to show some basic build instructions for Firefox users until we have it officially published.
This comment has been minimized.
This comment has been minimized.
Took out the Author
|
Can you please review this PR again? @nickmccurdy |
There was a problem hiding this comment.
Thanks, the package.json looks good now. I still think it would help to split up parts of the readme into CONTRIBUTING.md as I mentioned above, as there's a lot of information for developers that ordinary extension users don't need. Let me know if you need help with that.
No description provided.