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 missing #4

Open
11 tasks
giovanism opened this issue Oct 22, 2017 · 3 comments
Open
11 tasks

CONTRIBUTING.md missing #4

giovanism opened this issue Oct 22, 2017 · 3 comments

Comments

@giovanism
Copy link
Contributor

giovanism commented Oct 22, 2017

Add guidelines for issues, commit messages, and PRs.

So #3 won't happen again

Reference

https://github.com/blog/1184-contributing-guidelines
https://github.com/coala/coala/blob/master/CONTRIBUTING.rst

Proposal

  1. Source code (python)

    • Passed pylint source code analyzer (except C0103 for the time being)
    • Maximum line length is set to 79
    • File naming format (Lab)0[1-99]_[A-F](\+[A-F])?(_s[1-9])?(\.py)
    • ...
  2. Problem sets

    • Include only the necessary instruction and hint to complete the problem
    • Verbatim with necessary formatting adjustment
    • A footer
    • File naming format (Lab)0[1-99]_[A-F](\+[A-F])?(\.md)
    • ...
  3. Commit messages

    • First line < 50 chars
    • ...
  4. PRs

  5. Issues

@laymonage
Copy link
Owner

Yep, we need CONTRIBUTING.md in this repo. I like your proposal so far.
Some points I can think of right now:

  • For PyLint, we have a problem in class F's turtle solutions since they don't have any turtle object instantiation, which leads to an E1101 error. We're gonna use CI, and I think we can lint those solutions individually in CI (I'm not a fan of adding lint exceptions inside source codes).
  • Specify footer format for problem sets.
  • Add details about how images should be included.
  • Commit messages should use Sentence case. See previous commits for examples.
  • PRs' rules are pretty much the same as commit messages', but they're more flexible (I think?).

@giovanism
Copy link
Contributor Author

@laymonage , I think I can change class F solution to conform with PyLint's rule. Another thing to mention, would it be better for python source code filename format in lower case, to conform PyLint module name rule?

@laymonage
Copy link
Owner

I didn't know PyLint has rules for module names. Well, if you think so, feel free to send a PR that fixes it.

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

2 participants