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

Update docs #3836

Closed
Closed

Conversation

jamesgeorge007
Copy link
Contributor

@jamesgeorge007 jamesgeorge007 commented Dec 27, 2018

I think it is a good idea to have a badge welcoming pull requests pointing to the contributing.md file 🤔

@wesleytodd
Copy link
Member

Hey @jamesgeorge007. I feel like we discussed badges at some point and decided to use the badge board for these? Maybe it was in this one? #3710

@dougwilson
Copy link
Contributor

Yea, I'm iffy on adding a badge, of which a lot of those points are in what @wesleytodd linked to. But also I leaned that there are quite often new users who don't even know what "PR" stands for and I had to explain. I think if it's to be for users who don't think they can make a pull request in github already, they are likely in this group, so the PR badge is just going to go over their head.

Perhaps instead of a badge, there should just be a contributing section added to the readme? It could just have a basic blurb about making one and have the link to contributing like this badge does.

@jamesgeorge007
Copy link
Contributor Author

jamesgeorge007 commented Jan 4, 2019

@wesleytodd @dougwilson Well if that's the case, shall I proceed with adding contributing guidelines section to the Readme file pointing to contributing.md ?

Also, what are your thoughts on adding this badge:

Twitter

@dougwilson
Copy link
Contributor

@jamesgeorge007 that Twitter account does not belong to the express project.

@jamesgeorge007 jamesgeorge007 changed the title Add PR welcoming badge Update docs Jan 5, 2019
removes PR welcoming badge
@jamesgeorge007
Copy link
Contributor Author

@dougwilson Removed the badge and added contributing guidelines section as you suggested.
Is it the right position to place contributing guidelines within the docs as per now?

@wesleytodd
Copy link
Member

Two things:

  1. I think it might be best to put it in the "People" section? That way we dont add more small sections.
  2. You should rebase it to one commit.

@jamesgeorge007 jamesgeorge007 deleted the feat/add-badge branch January 5, 2019 07:38
@jamesgeorge007
Copy link
Contributor Author

jamesgeorge007 commented Jan 5, 2019

@wesleytodd @dougwilson I had to close this as part of switching to another branch.
Check out #3846

@wesleytodd
Copy link
Member

It is fine to open a new PR but also if you are interested, you can use git rebase to do this without having to change the branch. $ git rebase -i f47107a03ec741c05b05a4ae7548731f902cbd25 then pick squash for all but the first commit. Then git push --force your branch and it would just clean up the single PR. Hope that helps in the future. :)

@jamesgeorge007
Copy link
Contributor Author

@wesleytodd Check out this stack-overflow discussion

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