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

Define "small improvement" in Contributor's Guide #1028

Closed
it33 opened this issue Mar 29, 2017 · 6 comments
Closed

Define "small improvement" in Contributor's Guide #1028

it33 opened this issue Mar 29, 2017 · 6 comments
Assignees

Comments

@it33
Copy link
Contributor

it33 commented Mar 29, 2017

We need to update https://docs.mattermost.com/developer/contribution-guide.html with definition and examples of "small improvement".

Criteria:

  • Consensus improvement is small--i.e. 100% of core committers reviewing PR agree
  • Does not require an update to docs.mattermost.com
  • Not more than a few lines of changes

Examples (need to link to PR examples, we can probably fine better examples than these):

  • Adjustments to better align with UX guidelines
  • Tidying up small bits of code
  • Small improvements to make help text more clear
@prixone
Copy link
Contributor

prixone commented Mar 30, 2017

Examples
some one just update a file and forgot to update other methods of the same kind within a function of that file:
mattermost/mattermost#5878

@JeffSchering
Copy link
Contributor

Would the term "incremental improvement" in place of "small improvement" be more or less self-explanatory here?

@gluelue
Copy link

gluelue commented Apr 13, 2017

I agree with @JeffSchering on using the term "incremental improvement".

@jasonblais
Copy link
Contributor

See #1083 for proposed changes

@prixone
Copy link
Contributor

prixone commented Apr 15, 2017

@JeffSchering when I read "incremental" the first thing that comes to mind is something that will be on-going(so it sounds as if I am enlisting myself to a on-going improvement task) whereas "small" comes in as something of minor, in a fixed size. I do think that incremental would fit more in the "technical writing" jargon but as a person that often misunderstand technical writing, I would say "small" is much more friendly, or perhaps "minor improvement". Then again that is just my personal opinion, and perhaps I am the minority that sees it that way, or rather read it that way.

@jasonblais
Copy link
Contributor

Thanks @prixone for the feedback, really appreciate your input here.

I added a comment in my PR, which had a related note, feel free to add any feedback? #1083 (comment)

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

No branches or pull requests

5 participants