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

contributing.md - seek early feedback #356

Merged
merged 1 commit into from
Dec 23, 2015

Conversation

jamestalmage
Copy link
Contributor

As requested: #346 (comment)

@@ -33,6 +33,7 @@ We have a [chat](https://gitter.im/sindresorhus/ava). Jump in there and lurk, ta
### Submitting a pull request

- Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work.
- For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible. Open a PR as soon as you have done the minimum needed to demonstrate your idea. At this early stage, don't worry about making things perfect, or 100% complete. Add a [WIP] prefix to the title, and describe what you still need to do. This lets reviewers know not to nit-pick small details or point out improvements you already know you need make.
Copy link
Member

Choose a reason for hiding this comment

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

you need make => you need to make

Copy link
Member

Choose a reason for hiding this comment

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

PR => pull request

@sindresorhus sindresorhus changed the title maintaining.md: seek early feedback contributing.md - seek early feedback Dec 23, 2015
@jamestalmage
Copy link
Contributor Author

@sindresorhus - updated.

sindresorhus added a commit that referenced this pull request Dec 23, 2015
contributing.md - seek early feedback
@sindresorhus sindresorhus merged commit 65ae07c into avajs:master Dec 23, 2015
@sindresorhus
Copy link
Member

Excellent.

@jamestalmage jamestalmage deleted the seek-early-feedback branch December 23, 2015 03:08
@BarryThePenguin
Copy link
Contributor

For clarification, should an issue be raised for discussion first, then open a PR?

@jamestalmage
Copy link
Contributor Author

should an issue be raised for discussion first, then open a PR

Oh, absolutely. Does the line above not make that clear? Should we amend this:

For ambitious tasks, you should try to get your work in front of the community ...

To

Once consensus has been reached in the issue thread, and you've begun working on a solution, you should try to get your work...

@jamestalmage
Copy link
Contributor Author

Should have waited for a bit more consensus on this PR! 😉

@BarryThePenguin
Copy link
Contributor

Ah! I see it now, it's the first point. All good then..

Though the dot points are quite wordy, dot points should be short and sharp eg:

Open an issue. Non-trivial changes should be discussed first, to prevent you from doing unnecessary work.

@sindresorhus
Copy link
Member

Should have waited for a bit more consensus on this PR!

Ah, yes, but it looked pretty clear cut. Will give it some more time in the future.

@jamestalmage
Copy link
Contributor Author

I thought so to, I was just pointing out the irony that we rushed the PR that said "seek feedback ... find consensus".

@sindresorhus
Copy link
Member

Lol, that's true :p

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

Successfully merging this pull request may close these issues.

3 participants