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

Review README.md and CONTRIBUTING.md files #472

Closed
jasonblais opened this issue Mar 22, 2017 · 4 comments
Closed

Review README.md and CONTRIBUTING.md files #472

jasonblais opened this issue Mar 22, 2017 · 4 comments

Comments

@jasonblais
Copy link
Contributor

jasonblais commented Mar 22, 2017

Review README.md and CONTRIBUTING.md files

Creating an issue for @jasonblais to review the two files and update where needed

  1. README should really be for developers looking to contribute, and install guides, feature lists, etc.
  2. contribution guidelines way out of date and missing a note about testers. Could base it off of platform contribution guidelines: Update contributing guidelines for platform repo mattermost#5455
@jasonblais jasonblais added this to the v3.7.0/3.8.0 milestone Mar 22, 2017
@jasonblais jasonblais self-assigned this Mar 22, 2017
@jasonblais
Copy link
Contributor Author

Sorry @yuya-oc, I unfortunately won't have time to finish this up for end of this week..

I've started doing some research though, and added a few references below.

mattermost/mattermost#5455
https://github.com/mattermost/desktop/pull/350/files
https://github.com/nodejs/node
https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#landing-pull-requests
https://github.com/EionRobb/purple-mattermost

@jasonblais jasonblais modified the milestones: v3.8.0, v3.7.0 Apr 27, 2017
@yuya-oc
Copy link
Contributor

yuya-oc commented Oct 30, 2017

As mentioned at #637 (comment), we should also consider to define how changelog should be written. Currently "issues" are listed trailing to the sentence, but "pull requests" are not.

@philip-peterson
Copy link

Just for cross-referencers' sake, I was also suggesting back there that some distinction be made between PR number indicators and Issue number indicators (perhaps PR #4 and Issue #4 as a convention). Right now when you see #34 in the changelog it could mean either PR #34 or Issue #34.

@jasonblais jasonblais modified the milestones: v4.0.0, v4.1.0 Jan 18, 2018
@amyblais amyblais removed this from the v4.1.0 milestone Mar 21, 2018
@amyblais
Copy link
Member

amyblais commented Feb 8, 2019

@amyblais amyblais closed this as completed Feb 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants