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

Contributing.md should speak about make tidy #36191

Closed
GuillaumeGomez opened this issue Sep 1, 2016 · 4 comments
Closed

Contributing.md should speak about make tidy #36191

GuillaumeGomez opened this issue Sep 1, 2016 · 4 comments
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@GuillaumeGomez
Copy link
Member

For the moment, a lot of new contributors encounter an issue when they open a PR because they don't know about the make tidy command. It should be added.

cc @steveklabnik

@GuillaumeGomez GuillaumeGomez added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Sep 1, 2016
@Cobrand
Copy link
Contributor

Cobrand commented Sep 1, 2016

I volunteer as tribute !

Just to be sure I don't forget anything, make tidy checks for :

  • Trailing whitespaces
  • Length of all the lines of the file (which shouldn't be higher than 99)
  • TODOs in comments

Did I forget something ?

@steveklabnik
Copy link
Member

I think it'd be best to say "stuff like" rather than to exhaustively list, otherwise, it will go out of date.

On Sep 1, 2016, 15:59 -0400, Cobrand notifications@github.com, wrote:

I volunteer as tribute !

Just to be sure I don't forget anything, make tidy checks for :

Trailing whitespaces
Length of all the lines of the file (which shouldn't be higher than 99)
TODOs in comments

Did I forget something ?


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub (#36191 (comment)), or mute the thread (https://github.com/notifications/unsubscribe-auth/AABsis3MLM6WxqksJZlAYPOUnQme2a-Zks5qly5xgaJpZM4JyxLs).

@GuillaumeGomez
Copy link
Member Author

@Cobrand: I'm not sure it's really needed to add all of this but I think you have everything.

@Cobrand
Copy link
Contributor

Cobrand commented Sep 8, 2016

I guess this can be closed now ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Development

No branches or pull requests

3 participants