@taurgis/sfccdx
Version:
SFCCDX is a command line interface (CLI) for Salesforce Commerce Cloud. It can be used to easily manage (meta)data (import/export) in relation to your project.
33 lines (23 loc) • 1.93 kB
Markdown
# Contributing
Thanks much for contributing - To contribute to this project, please follow the recommendations and requirements below. This helps to address your contribution in a timely manner. Contributing is done through submitting pull requests.
# Issues, Requests & Ideas
Use GitHub [Issues](https://github.com/taurgis/sfccdx/issues) page to submit issues, enhancement requests and discuss ideas.
# Submitting a Pull Request
1. **Ensure the bug/feature was not already reported** by searching on GitHub under [Issues](https://github.com/taurgis/sfccdx/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 repo.
3. **Clone** the forked repo to your machine.
4. **Commit** changes to your *own branch*.
5. **Push** your work back up to your fork.
6. **Submit** a [Pull Request](https://github.com/taurgis/sfccdx/pulls) against the `master` 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.
**NOTE**: Make sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request.
# Contribution Checklist #
* Use clean, simple, well styled code.
* Use comments.
* Minimize number of dependencies.
* Make sure that your code builds, lints and passes the unit tests.
* Increase code coverage, not versa.
* To reduce merge conflicts, rebase your branch before submitting your pull request.
* Reference the issue number in the comments of your pull request.
* Monitor your pull requests. Please respond in a timely manner to any comments, questions for changes requested. Abandoned pull requests may be closed.
# License
By contributing code, you agree to license your contribution under the terms of the [BSD 3-Clause](LICENSE.md).