Making Lwt even more welcoming to new contributors (CONTRIBUTING.md) #379
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
|
Awesome work. This looks so much more contributor friendly. For some more inspiration you can look at this https://github.com/sympy/sympy/wiki#development We need a way to surface these easy issues and so that more people contrbute. May be we can do weekly thread on discuss.ocaml.org where projects can post new contributor friendly issues. @avsm any thoughts? |
5cc0ce5
to
4e4dff3
Compare
[skip ci]
aantron
added a commit
that referenced
this pull request
Jun 1, 2017
This is to avoid GitHub showing a warning to read CONTRIBUTING.md when one is creating a new issue. The current CONTRIBUTING.md does not contain any information relevant to creating new issues. Related #379. [skip ci]
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.
Let's continue making Lwt more welcoming to contributors. This PR adds some basic contributing documentation:
READMEis expanded.CONTRIBUTING.md.These should be considered as drafts; I just can't keep looking directly at them – feeling a sort of "writing lock" from thinking about them for days straight :) Maybe others have some fresh ideas :)
I've also added:
Easy issues should usually be left for new contributors. They should contain a thorough description of how to do the change, including testing.
I plan to later add guides on specific tasks to
CONTRIBUTING.md. Ideally, this would make some otherwise-difficult issues easy, as contributors can be linked to the guides, and can then follow them rather closely. Potential topics for guides:getcwdissue.cc @vramana: thanks for linking me to that video full of ideas. I'd appreciate your thoughts on this :)