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

Write a contributing guidelines file #13

Open
tlein opened this issue Mar 10, 2018 · 0 comments
Open

Write a contributing guidelines file #13

tlein opened this issue Mar 10, 2018 · 0 comments
Labels
Milestone

Comments

@tlein
Copy link
Member

tlein commented Mar 10, 2018

Formatting

  • 4 spaces as tab
  • TypeScript type colons hug the identifier, not the type
  • Open curly brackets are on the same line
  • Must always use curly brackets around if/while/for/etc...
  • All private members (variables, functions, get/set) must begin with an underscore (_)
  • Variables and functions are camelCase
  • const variable names are SCREAMING_CASE
  • Must pass all linter formatting checks

Writing Issues

  • Describe what is the problem
  • Provide a relevant sample code demonstrating the problem if necessary

Opening Pull Requests

  • Unit test all new functionality
  • E2E test when appropriate
  • Follow PR description format as they are used as the squash commit for the PR
@tlein tlein added this to the 1.0.0-alpha1 milestone Mar 10, 2018
@tlein tlein added the repo label Mar 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant