Skip to content

Latest commit

 

History

History
90 lines (69 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

90 lines (69 loc) · 4.46 KB
Raw

Contributing Guide

Currently, we aren't accepting external contributions. To know when we open for contributions, periodically check this guide.

To contribute, read this guide to understand its operational governance model. This guide also provides contribution requirements and recommendations. Thanks for your interest and contributions.

Governance Model

Salesforce Sponsored

The intent and goal of open sourcing this project is to increase the contributor and user base. Note that Salesforce employees have admin rights and are the final arbiters which contributions are accepted.

Issues, requests & ideas

To submit issues, enhancement requests, and discuss ideas, create an issue on the Issues page.

Bug Reports and Fixes

  • If you find a bug, search for it in the Issues, and if it isn't already tracked, create a new issue. Fill out the "Bug Report" section of the issue template. Even if an issue is closed, feel free to comment and add details, it will still be reviewed.
  • Issues that have been confirmed as a bug will be labelled bug.
  • If you want to submit a bug fix, create a pull request and mention the issue number.
  • In your bug fix pull request, include tests that isolate the bug and verify that it's fixed.

New Features

  • To add new functionality, describe the problem you want to solve - or the enhancement you identifed - in a new issue.
  • Issues that are identified as a feature request are labelled enhancement.
  • Before writing the code for your newly requested feature, first wait for feedback from the project maintainers. In some cases, requested enhancements don't align well with the current project objectives.

Tests, Documentation, Miscellaneous

  • We welcome your contributions to:
    • improving tests
    • clarifying documentation
    • requesting alternative implementations
  • If it's a trivial change, go ahead and create a pull request with the changes you have in mind.
  • If your request is larger in size, open an issue to get feedback on your idea.

Contribution Checklist

  • Clean, simple, well styled code
  • Atomic commits and descriptive messages. Mention related issues by issue number
  • Comments
    • Module-level & function-level comments
    • Comments on complex blocks of code or algorithms (include references to sources)
  • Tests
    • Complete, passing test suite test suite (if provided)
    • Maintain or increase code coverage percentages
  • Dependencies
    • Minimize number of dependencies
    • Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses
  • Reviews
    • Approved peer code review changes

Local Development

Install Dependencies

Install required node dependencies:

npm install

Building Code

Build the source code with:

npm run build

Running Tests

We strive for 100% code coverage. After making your changes, run your tests and check coverage with:

npm run test

Creating a Pull Request

  1. Ensure the bug or feature wasn't already reported by searching on GitHub under Issues. If none exists, create a new issue so that other contributors can keep track of what you are trying to add or fix and offer suggestions, or let you know if there is already an effort in progress.
  2. Clone the forked repo to your machine.
  3. Create a new branch to contain your work. Example: git br fix-issue-11
  4. Commit changes to your own branch.
  5. Push your work back up to your fork. Example: git push fix-issue-11
  6. Submit a pull request against the main branch and refer to the issue you're fixing. Keep your pull request simple and small to avoid any unintended changes.
  7. Sign the Salesforce Contributor License Agreement (CLA). You will be prompted to do so when submitting your pull request.

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

Code of Conduct

Please follow our Code of Conduct.

License

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