Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 2.21 KB
Raw

Contributing Guide For React HK Components

This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to React HK Components. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes.

Governance Model

Published but not supported

The intent and goal of open sourcing this project is because it may contain useful or interesting code/concepts that we wish to share with the larger open source community. Although occasional work may be done on it, we will not be looking for or soliciting contributions.

Getting started

See instructions in the README file.

Contribution Checklist

  • Clean, simple, well styled code
  • Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
  • Comments
    • Module-level & function-level comments.
    • Comments on complex blocks of code or algorithms (include references to sources).
  • Tests
    • The test suite, if provided, must be complete and pass
    • Increase code coverage, not versa.
  • Dependencies
    • Minimize number of dependencies.
    • Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
  • Reviews
    • Changes must be approved by the Heroku Front-end team.

Creating a Pull Request

  1. Clone the forked repo to your machine.
  2. Create a new branch to contain your work (e.g. git br fix-issue-11)
  3. Commit changes to your own branch.
  4. Push your work back up to your fork. (e.g. git push fix-issue-11)
  5. Submit a Pull Request against the main branch and refer to the issue(s) you are fixing. Try not to pollute your pull request with unintended changes. Keep it simple and small.
  6. Sign the Salesforce CLA (you will be prompted to do so when submitting the Pull Request)

NOTE: Be sure to sync your fork before making a pull request.

License

By contributing your code, you agree to license your contribution under the terms of our project LICENSE and to sign the Salesforce CLA