Skip to content

Commit 43ffbd4

Browse files
committed
Upload required file(s) for compliance
1 parent 538e00c commit 43ffbd4

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing Guide
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 it. 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+
7+
## Published but not supported
8+
9+
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.
10+
11+
# Getting started
12+
13+
Please join the community. Also please make sure to take a look at the project [roadmap](ROADMAP.md), if it exists, to see where are headed.
14+
15+
# Issues, requests & ideas
16+
17+
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
18+
19+
### Bug Reports and Fixes
20+
- If you find a bug, please search for it in the Issues, and if it isn't already tracked,
21+
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
22+
be reviewed.
23+
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
24+
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
25+
- Include tests that isolate the bug and verifies that it was fixed.
26+
27+
### New Features
28+
- If you'd like to add new functionality to this project, describe the problem you want to solve in a new Issue.
29+
- Issues that have been identified as a feature request will be labelled `enhancement`.
30+
- If you'd like to implement the new feature, please wait for feedback from the project
31+
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
32+
not align well with the project objectives at the time.
33+
34+
### Tests, Documentation, Miscellaneous
35+
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
36+
alternative implementation of something that may have advantages over the way its currently
37+
done, or you have any other change, we would be happy to hear about it!
38+
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
39+
- If not, open an Issue to discuss the idea first.
40+
41+
If you're new to our project and looking for some way to make your first contribution, look for
42+
Issues labelled `good first contribution`.
43+
44+
# Contribution Checklist
45+
46+
- [x] Clean, simple, well styled code
47+
- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
48+
- [x] Comments
49+
- Module-level & function-level comments.
50+
- Comments on complex blocks of code or algorithms (include references to sources).
51+
- [x] Tests
52+
- The test suite, if provided, must be complete and pass
53+
- Increase code coverage, not versa.
54+
- 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.
55+
- [x] Dependencies
56+
- Minimize number of dependencies.
57+
- Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
58+
- [x] Reviews
59+
- Changes must be approved via peer code review
60+
61+
# Creating a Pull Request
62+
63+
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).
64+
3. **Clone** the forked repo to your machine.
65+
4. **Create** a new branch to contain your work (e.g. `git br fix-issue-11`)
66+
4. **Commit** changes to your own branch.
67+
5. **Push** your work back up to your fork. (e.g. `git push fix-issue-11`)
68+
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.
69+
7. **Sign** the Salesforce CLA (you will be prompted to do so when submitting the Pull Request)
70+
71+
> **NOTE**: Be sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request.
72+
73+
74+
# Code of Conduct
75+
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
76+
77+
# License
78+
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)