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.

Sign up for GitHub

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

Jump to bottom

Add and enforce best practices #185

Merged
merged 5 commits into from
Sep 13, 2020
Merged

Add and enforce best practices #185

merged 5 commits into from
Sep 13, 2020

Conversation

henrifroese
Copy link
Collaborator

@henrifroese henrifroese commented Sep 13, 2020 •
edited
Loading

This PR adds new best practices to CONTRIBUTING.md and enforces them in the code:

  1. Docstring for default values (now e.g. x : int, optional, default=2)
  2. Selection of default argument values (try to use defaults of the underlying library called, else look at other similar functions; finally explain if something else is used)
  3. American English (instead of British English)

henrifroese and others added 5 commits September 4, 2020 09:51
@henrifroese
Fix travis version. See Issue jbesomi#171
53632f0
@henrifroese
roll back accidental push to master
b329fb3
@henrifroese
Merge branch 'master' of https://github.com/SummerOfCode-NoHate/texthero
566fef8
@henrifroese @mk2510
Add & Enforce best practices.
7eeab4d 
- default argument docstring style
- American English
- default argument values

All those are also added to CONTRIBUTING.md

Co-authored-by: Maximilian Krahn <maximilian.krahn@icloud.com>
@henrifroese
Merge remote-tracking branch 'upstream/master' into general_rules
e108d8b
@henrifroese henrifroese added the documentation Improvements or additions to documentation label Sep 13, 2020
@jbesomi jbesomi merged commit 22791b1 into jbesomi:master Sep 13, 2020
@jbesomi
Copy link
Owner

jbesomi commented Sep 13, 2020

Amazing, thanks! 🎉 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mk2510 mk2510 Awaiting requested review from mk2510

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@henrifroese @jbesomi