Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a better Contributing guideline #92

Closed
gaearon opened this issue Jul 22, 2016 · 3 comments
Closed

Add a better Contributing guideline #92

gaearon opened this issue Jul 22, 2016 · 3 comments

Comments

@gaearon
Copy link
Contributor

gaearon commented Jul 22, 2016

We should explain:

  • Constraints (e.g. no flags, no configuration)
  • Strategies (find good defaults, good heuristics can make)
  • Actively find ways to improve DX (e.g. remove noise, implement things you didn’t see in other tools but wish were there)
  • Try to make the least controversial choices (would that work for 95% of users? would beginners understand this?)
  • Coordinate on an issue in case somebody else is already working on the PR you want
  • If you submit a PR please provide a test plan (how did you verify it works?)
  • Release guidelines (how to run the script, update changelog etc)
@ghost
Copy link

ghost commented Jul 23, 2016

@gaearon Would it be reasonable to assume we want to include this content into a CONTRIBUTING.md? Or would we want to go with the Wiki page route?

@lacker
Copy link
Contributor

lacker commented Jul 23, 2016

For "Try to make the least controversial choices" - I think we need to go a bit farther, and say, if the community is split between N different tools, then we won't just pick the least controversial, the tool itself should be agnostic between them. Like installing redux by default would be less controversial than installing mobx by default but that doesn't mean we should do it.

@gaearon
Copy link
Contributor Author

gaearon commented Jul 23, 2016

Would it be reasonable to assume we want to include this content into a CONTRIBUTING.md?

Yes.

if the community is split between N different tools, then we won't just pick the least controversial, the tool itself should be agnostic between them

Agree.

Like installing redux by default would be less controversial than installing mobx by default but that doesn't mean we should do it.

Yes. Also worth noting that we are only currently interested in solving build problem, not runtime dependencies. We leave you with React and let you be (for now).

mxstbr added a commit that referenced this issue Jul 24, 2016
mxstbr added a commit that referenced this issue Jul 24, 2016
gaearon pushed a commit that referenced this issue Jul 24, 2016
@gaearon gaearon closed this as completed Sep 3, 2016
@lock lock bot locked and limited conversation to collaborators Jan 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants