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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add yourself as a contributor #677

Merged
merged 1 commit into from Oct 11, 2017
Merged

Docs: Add yourself as a contributor #677

merged 1 commit into from Oct 11, 2017

Conversation

DirtyF
Copy link
Contributor

@DirtyF DirtyF commented Oct 11, 2017

Fix #676

  • Add instructions to CONTRIBUTING to add yourself as a contributor (copied from the original project)
  • Following those instructions and adding myself as a contributor 馃槃

/cc @verythorough

Copy link
Contributor

@erquhart erquhart left a comment

Choose a reason for hiding this comment

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

Thanks @DirtyF!

@verythorough
Copy link
Contributor

Thanks! I have a few comments on the instructions that I'll be adding shortly, between talks at GitHub Universe. :)

Copy link
Contributor

@Benaiah Benaiah left a comment

Choose a reason for hiding this comment

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

@verythorough do you want merging this to wait for your comments? This LGTM otherwise.

@verythorough
Copy link
Contributor

@Benaiah I was thinking so, but you know, it's already an improvement as is, so I guess we're good to merge!

As for my comments, I'm thinking of ways to make this process simpler for people who don't have the repo cloned and installed locally, but that can certainly wait.

Merging!

@verythorough verythorough merged commit b0bf60b into decaporg:master Oct 11, 2017
@DirtyF DirtyF deleted the docs-contributors branch October 11, 2017 22:17
@DirtyF
Copy link
Contributor Author

DirtyF commented Oct 11, 2017

@verythorough Alternatively you can add yourself manually to the .allcontributors.rc JSON file but this means a maintainer will then have to run the generate contributors script (by hand or through a hook).

As this is a node project, I thought the majority of contributors were familiar with npm scripts.

@verythorough
Copy link
Contributor

@DirtyF Yeah, I'm more thinking of people who write external tutorials or file detailed bug reports, for example. Or maybe they corrected typos using the Github web UI. All of these contributions are valued in the all-contributors spec, but in all of these cases, you don't need to clone the repo to make a contribution.

In these cases, perhaps filing an issue to add a person is a feasible alternative, since it's pretty easy for any regular contributor who's already cloned and installed to just run the command an push it.

@DirtyF
Copy link
Contributor Author

DirtyF commented Oct 11, 2017

I agree it would be more effective to have a script that fetches the data from GitHub and not asking users about this, but it isn't what all-contributors do.

There are other similar projects on Github like https://github.com/LABHR/hatrack

With all the people who ever left a comment you're over 220:
https://labhr.github.io/hatrack/#repo=netlify/netlify-cms

@verythorough
Copy link
Contributor

Interesting concept. I hadn't seen that tool. I do like the human interaction required with all-contributors, though, because, for example, not all contributors might comment, and not all "+1 fix now plz" comments really qualify as contributions.

In the end, the all-contributors process is pretty low friction, and I really appreciate your integrating the cli tool to make it so. My penchant for making sure docs address as many use cases as possible shouldn't detract from that. Thanks again for making this happen!

aquibm pushed a commit to aquibm/netlify-cms that referenced this pull request Oct 17, 2017
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.

None yet

4 participants