Skip to content

Latest commit

 

History

History
88 lines (56 loc) · 5.29 KB

CONTRIBUTING.md

File metadata and controls

88 lines (56 loc) · 5.29 KB
Raw

Contributing to Accounts

TL;DR; Tests, coverage, linting, changelog (See Pull Request Requirements, below).

The Accounts project was intended - since its inception - to be a community maintained project. We would love to see you get involved (especially long time contributors from the Meteor community who we've worked with before).

Getting Started

  1. Fork the project on Github (top right on the project page)
  2. Clone the project: git clone [email protected]:yourname/accounts
  3. Checkout a relevant branch like: git checkout some-branch
  4. Create your own feature branch: git checkout -b proposed-feature

Development

Useful Commands:

  • Install project dependencies: yarn
  • Link together all the packages: yarn setup
  • Compile the packages yarn compile
  • Watch the packages for changes and recompile: yarn start (You need to run this command in the package subfolder you are updating)
  • If you want to use the accounts project in your own project, use yarn link @accounts/<name of package> within your project.
  • Run docker-compose up -d to start database services required for tests.
  • Run yarn test to run all the tests.

Pull Requests

Requirements

For non-bug-fixes, please open an issue first and discuss your idea to make sure we're on the same page.
Alternatively, prepend your PR title with [discuss] to have a conversation around the code.

All PRs:

  1. Must not break the test suite (yarn test), nor reduce test coverage (yarn coverage). If you're fixing a bug, include a test that would fail without your fix.

  2. Must respect the .eslintrc.js (yarn test:lint). Ideally your editor supports eslint. Especially since the project is quite new, feel free to query default rules with us that don't make sense, or disable rules in a particular scope when it makes sense, together with a comment explaining why.

  3. Must be isolated. Avoid grouping many, unrelated changes in a single PR.

  4. GitHub now allows auto-squashing of commits in a PR, so no need to rebase your commits before final submission.

Submission

  1. From Getting Started, your work should ideally be in its own feature branch.
  2. git push your branch to git and create a new pull request for the appropriate branch.

Contributors with Commit Bit

  • Should still submit a PR for changes (i.e. no work should be done on a branch directly; all work should be done in it's own separate feature branch), which should be okayed by one other team member before merging.

  • Should squash merged PRs whenever possible (via GitHub options).

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Credits

Contributors

Thank you to all the people who have already contributed to accounts-js!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)