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

Changing README and CONTRIBUTING (related to #401) #403

Open
wants to merge 6 commits into
base: master
from

Conversation

Projects
None yet
1 participant
@diyadas
Collaborator

diyadas commented Nov 15, 2018

I've outlined the changes to the top of the README that I'd like to see for newcomers, as outlined in #401 > 2.

I also noted that there was a lot of contributing information in the README, which I found redundant and confusing with the actual CONTRIBUTING file, so I moved that to CONTRIBUTING. I also moved information about making PRs to one location in the CONTRIBUTING file, instead of split across 2.

In a separate commit, I also removed the "What not to contribute" header -- prior to becoming in a maintainer, I have always glanced over this assuming that "what to contribute" aligned with my contribution. Imo, keeping that information in one section ensures that people are more likely to read it. We can skip this if you do not feel the same.

This is very experimental and I welcome discussion/edits to this PR. It was easier to make the changes as a proposal than to describe them exactly.

(and I have no idea why all these merge commits are coming up, sorry)

@diyadas diyadas requested review from fmichonneau and katrinleinweber Nov 15, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment