Skip to content

Commit 2ebe55a

Browse files
committed
@W-22517579 add CONTRIBUTING.md
1 parent 8a21b80 commit 2ebe55a

1 file changed

Lines changed: 100 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Contributing Guide For salesforcecli plugin-data-setup-transfer
2+
3+
This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to salesforcecli plugin-data-setup-transfer. 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.
4+
5+
# Governance Model
6+
> Pick the most appropriate one
7+
8+
## Community Based
9+
10+
The intent and goal of open sourcing this project is to increase the contributor and user base. The governance model is one where new project leads (`admins`) will be added to the project based on their contributions and efforts, a so-called "do-acracy" or "meritocracy" similar to that used by all Apache Software Foundation projects.
11+
12+
> or
13+
14+
## Salesforce Sponsored
15+
16+
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 arbitrars of what contributions are accepted or not.
17+
18+
> or
19+
20+
## Published but not supported
21+
22+
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.
23+
24+
# Getting started
25+
26+
Please join the community on {Here list Slack channels, Email lists, Glitter, Discord, etc... links}. Also please make sure to take a look at the project [roadmap](ROADMAP.md) to see where are headed.
27+
28+
# Issues, requests & ideas
29+
30+
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
31+
32+
### Bug Reports and Fixes
33+
- If you find a bug, please search for it in the [Issues](https://github.com/salesforcecli/plugin-data-setup-transfer/issues), and if it isn't already tracked,
34+
[create a new issue](https://github.com/salesforcecli/plugin-data-setup-transfer/issues/new). 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
35+
be reviewed.
36+
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
37+
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
38+
- Include tests that isolate the bug and verifies that it was fixed.
39+
40+
### New Features
41+
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/salesforcecli/plugin-data-setup-transfer/issues/new).
42+
- Issues that have been identified as a feature request will be labelled `enhancement`.
43+
- If you'd like to implement the new feature, please wait for feedback from the project
44+
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
45+
not align well with the project objectives at the time.
46+
47+
### Tests, Documentation, Miscellaneous
48+
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
49+
alternative implementation of something that may have advantages over the way its currently
50+
done, or you have any other change, we would be happy to hear about it!
51+
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
52+
- If not, [open an Issue](https://github.com/salesforcecli/plugin-data-setup-transfer/issues/new) to discuss the idea first.
53+
54+
If you're new to our project and looking for some way to make your first contribution, look for
55+
Issues labelled `good first contribution`.
56+
57+
# Contribution Checklist
58+
59+
- [x] Clean, simple, well styled code
60+
- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
61+
- [x] Comments
62+
- Module-level & function-level comments.
63+
- Comments on complex blocks of code or algorithms (include references to sources).
64+
- [x] Tests
65+
- The test suite, if provided, must be complete and pass
66+
- Increase code coverage, not versa.
67+
- Use any of our testkits that contains a bunch of testing facilities you would need. For example: `import com.salesforce.op.test._` and borrow inspiration from existing tests.
68+
- [x] Dependencies
69+
- Minimize number of dependencies.
70+
- Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
71+
- [x] Reviews
72+
- Changes must be approved via peer code review
73+
74+
# Creating a Pull Request
75+
76+
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).
77+
2. **Clone** the forked repo to your machine.
78+
3. **Create** a new branch to contain your work (e.g. `git br fix-issue-11`)
79+
4. **Commit** changes to your own branch.
80+
5. **Push** your work back up to your fork. (e.g. `git push fix-issue-11`)
81+
6. **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.
82+
7. **Sign** the Salesforce CLA (you will be prompted to do so when submitting the Pull Request)
83+
84+
> **NOTE**: Be sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request.
85+
86+
# Contributor License Agreement ("CLA")
87+
In order to accept your pull request, we need you to submit a CLA. You only need
88+
to do this once to work on any of Salesforce's open source projects.
89+
90+
Complete your CLA here: <https://cla.salesforce.com/sign-cla>
91+
92+
# Issues
93+
We use GitHub issues to track public bugs. Please ensure your description is
94+
clear and has sufficient instructions to be able to reproduce the issue.
95+
96+
# Code of Conduct
97+
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
98+
99+
# License
100+
By contributing your code, you agree to license your contribution under the terms of our project [LICENSE](LICENSE.txt) and to sign the [Salesforce CLA](https://cla.salesforce.com/sign-cla)

0 commit comments

Comments
 (0)