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

So you wanna PR one of my JavaScript repos #2

Open
mk-pmb opened this issue Oct 31, 2019 · 0 comments
Open

So you wanna PR one of my JavaScript repos #2

mk-pmb opened this issue Oct 31, 2019 · 0 comments

Comments

@mk-pmb
Copy link
Owner

mk-pmb commented Oct 31, 2019

cool, thanks! Here are my default guidelines:

  • If the repo has its own guidelines and they conflict, the more specific one wins.
  • If a guideline would conflict with common sense, follow common sense.
  • Consider adding yourself to the contributors list in package.json if you like.
    • Keep them sorted alphabetically please.
    • However, to avoid diff noise, it would be a good idea to make one entry stay at the bottom at all times.
      • If the current maintainer (probably me) is in that list, let's keep their item at bottom.
      • Also please add an empty line above that so I can use the "select remainder of paragraph" command for easy sort.
  • When my files start with jslint directives and I haven't configured a linter, they're meant for jslint --edition=2013-08-26.
    • (I mostly understand why the later jslint editions – or rather, the concepts behind the new rules and defaults – are superior, but I'm not yet able to accept that insight.)
    • Feel free to add "lint": "jslint --edition=2013-08-26 '**/*.js{,on}'", to the npm scripts. I'm usually too lazy because in my shell it's just three letters to invoke a proprietary unified lint tool that lints even more stuff.
  • If you wonder about my package.json's npm vs. BOM = Unexpected token field, see here.
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

1 participant