Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
147 lines (104 loc) · 6.54 KB

CONTRIBUTING.md

File metadata and controls

147 lines (104 loc) · 6.54 KB

Contributing Guide For plugin-app-dev

This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to plugin-app-dev. 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

Salesforce Sponsored

The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given admin rights and will be the final arbiters of what contributions are accepted or not.

Getting started

Please join the community on the Salesforce Trailblazer Community. Also please make sure to review the Salesforce CLI documentation.

Issues, requests & ideas

Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.

Bug Reports and Fixes

  • If you find a bug, please 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 already been identified as a bug (note: able to reproduce) will be labelled bug.
  • If you'd like to submit a fix for a bug, send a Pull Request and mention the Issue number.
  • Include tests that isolate the bug and verifies that it was fixed.

New Features

  • If you'd like to add new functionality to this project, describe the problem you want to solve in a new Issue.
  • Issues that have been identified as a feature request will be labelled enhancement.
  • If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, enhancements may not align well with the project objectives at the time.

Tests, Documentation, Miscellaneous

  • If you'd like to improve the tests, you want to make the documentation clearer, you have an alternative implementation of something that may have advantages over the way its currently done, or you have any other change, we would be happy to hear about it!
  • If its a trivial change, go ahead and send a Pull Request with the changes you have in mind.
  • If not, open an Issue to discuss the idea first.

If you're new to our project and looking for some way to make your first contribution, look for Issues labelled good first contribution.

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 must be complete and pass
    • Increase code coverage, not versa.
    • Try to achieve at least 95% code coverage on any new code.
  • Dependencies
    • Minimize number of dependencies.
    • Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
  • Reviews
    • Changes must be approved via peer code review

Creating a Pull Request

  1. Ensure the bug/feature was not 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/fix and offer suggestions (or let you know if there is already an effort in progress).
  2. Fork this repository.
  3. Clone the forked repo to your machine.
  4. Create a new branch to contain your work (e.g. git checkout -b fix-issue-11)
  5. Make your changes and commit them with descriptive messages.
  6. Build and test your changes locally: 
    yarn && yarn build
yarn test
  7. Push your work back up to your fork. (e.g. git push origin fix-issue-11)
  8. 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.
  9. 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.

Building the Plugin

To build the plugin locally, make sure to have Node.js (>=18.0.0) and Yarn installed and run the following commands:

# Clone the repository
git clone git@github.com:salesforcecli/plugin-app-dev.git
cd plugin-app-dev

# Install the dependencies and compile
yarn && yarn build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file
./bin/dev webapp dev --help

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins

Testing

All code changes should include appropriate tests. The project uses:

  • Unit tests: Mocha and NYC for code coverage
  • NUT tests: Integration tests for end-to-end scenarios
# Run unit tests
yarn test

# Run integration tests
yarn test:nuts

# Run a specific test file
yarn test:only

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Salesforce's open source projects.

Complete your CLA here: https://cla.salesforce.com/sign-cla

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. Please also report any issues at https://github.com/forcedotcom/cli/issues.

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