Skip to content

Commit 435a48a

Browse files
ukanoja-sfukanoja-sf
committed
docs: add CONTRIBUTING.md and how_to_license.md from Salesforce OSS template
1 parent 14b5c5b commit 435a48a

2 files changed

Lines changed: 345 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing Guide For plugin-license-management
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 plugin-license-management. 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+
## Salesforce Sponsored
8+
9+
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.
10+
11+
# Getting started
12+
13+
# Issues, requests & ideas
14+
15+
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
16+
17+
### Bug Reports and Fixes
18+
19+
- If you find a bug, please search for it in the [Issues](https://github.com/salesforcecli/plugin-license-management/issues), and if it isn't already tracked,
20+
[create a new issue](https://github.com/salesforcecli/plugin-license-management/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
21+
be reviewed.
22+
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
23+
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating-a-pull-request) and mention the Issue number.
24+
- Include tests that isolate the bug and verifies that it was fixed.
25+
26+
### New Features
27+
28+
- 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-license-management/issues/new).
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+
36+
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
37+
alternative implementation of something that may have advantages over the way its currently
38+
done, or you have any other change, we would be happy to hear about it!
39+
- If its a trivial change, go ahead and [send a Pull Request](#creating-a-pull-request) with the changes you have in mind.
40+
- If not, [open an Issue](https://github.com/salesforcecli/plugin-license-management/issues/new) to discuss the idea first.
41+
42+
If you're new to our project and looking for some way to make your first contribution, look for
43+
Issues labelled `good first contribution`.
44+
45+
# Contribution Checklist
46+
47+
- [x] Clean, simple, well styled code
48+
- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
49+
- [x] Comments
50+
- Module-level & function-level comments.
51+
- Comments on complex blocks of code or algorithms (include references to sources).
52+
- [x] Tests
53+
- The test suite, if provided, must be complete and pass
54+
- Increase code coverage, not versa.
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+
2. **Clone** the forked repo to your machine.
65+
3. **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+
# Contributor License Agreement ("CLA")
74+
75+
In order to accept your pull request, we need you to submit a CLA. You only need
76+
to do this once to work on any of Salesforce's open source projects.
77+
78+
Complete your CLA here: <https://cla.salesforce.com/sign-cla>
79+
80+
# Issues
81+
82+
We use GitHub issues to track public bugs. Please ensure your description is
83+
clear and has sufficient instructions to be able to reproduce the issue.
84+
85+
# Code of Conduct
86+
87+
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
88+
89+
# License
90+
91+
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)

‎how_to_license.md‎

Lines changed: 254 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,254 @@
1+
## How To License Info
2+
3+
Most projects we open source should use the [Apache License v2](https://opensource.org/license/apache-2-0/) license. Samples, demos, and blog / doc code examples should instead use [CC-0](https://creativecommons.org/publicdomain/zero/1.0/). If you strongly feel your project should perhaps use a different license clause, please engage with legal team.
4+
5+
For this guide, we will assume the use of the ALv2.
6+
7+
For the ALv2 license, create a `LICENSE.txt` file (or use the one in this template repo) in the root of your repo containing:
8+
9+
```
10+
Apache License Version 2.0
11+
12+
Copyright (c) 2026 Salesforce, Inc.
13+
All rights reserved.
14+
15+
Apache License
16+
Version 2.0, January 2004
17+
http://www.apache.org/licenses/
18+
19+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
20+
21+
1. Definitions.
22+
23+
"License" shall mean the terms and conditions for use, reproduction,
24+
and distribution as defined by Sections 1 through 9 of this document.
25+
26+
"Licensor" shall mean the copyright owner or entity authorized by
27+
the copyright owner that is granting the License.
28+
29+
"Legal Entity" shall mean the union of the acting entity and all
30+
other entities that control, are controlled by, or are under common
31+
control with that entity. For the purposes of this definition,
32+
"control" means (i) the power, direct or indirect, to cause the
33+
direction or management of such entity, whether by contract or
34+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
35+
outstanding shares, or (iii) beneficial ownership of such entity.
36+
37+
"You" (or "Your") shall mean an individual or Legal Entity
38+
exercising permissions granted by this License.
39+
40+
"Source" form shall mean the preferred form for making modifications,
41+
including but not limited to software source code, documentation
42+
source, and configuration files.
43+
44+
"Object" form shall mean any form resulting from mechanical
45+
transformation or translation of a Source form, including but
46+
not limited to compiled object code, generated documentation,
47+
and conversions to other media types.
48+
49+
"Work" shall mean the work of authorship, whether in Source or
50+
Object form, made available under the License, as indicated by a
51+
copyright notice that is included in or attached to the work
52+
(an example is provided in the Appendix below).
53+
54+
"Derivative Works" shall mean any work, whether in Source or Object
55+
form, that is based on (or derived from) the Work and for which the
56+
editorial revisions, annotations, elaborations, or other modifications
57+
represent, as a whole, an original work of authorship. For the purposes
58+
of this License, Derivative Works shall not include works that remain
59+
separable from, or merely link (or bind by name) to the interfaces of,
60+
the Work and Derivative Works thereof.
61+
62+
"Contribution" shall mean any work of authorship, including
63+
the original version of the Work and any modifications or additions
64+
to that Work or Derivative Works thereof, that is intentionally
65+
submitted to Licensor for inclusion in the Work by the copyright owner
66+
or by an individual or Legal Entity authorized to submit on behalf of
67+
the copyright owner. For the purposes of this definition, "submitted"
68+
means any form of electronic, verbal, or written communication sent
69+
to the Licensor or its representatives, including but not limited to
70+
communication on electronic mailing lists, source code control systems,
71+
and issue tracking systems that are managed by, or on behalf of, the
72+
Licensor for the purpose of discussing and improving the Work, but
73+
excluding communication that is conspicuously marked or otherwise
74+
designated in writing by the copyright owner as "Not a Contribution."
75+
76+
"Contributor" shall mean Licensor and any individual or Legal Entity
77+
on behalf of whom a Contribution has been received by Licensor and
78+
subsequently incorporated within the Work.
79+
80+
2. Grant of Copyright License. Subject to the terms and conditions of
81+
this License, each Contributor hereby grants to You a perpetual,
82+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83+
copyright license to reproduce, prepare Derivative Works of,
84+
publicly display, publicly perform, sublicense, and distribute the
85+
Work and such Derivative Works in Source or Object form.
86+
87+
3. Grant of Patent License. Subject to the terms and conditions of
88+
this License, each Contributor hereby grants to You a perpetual,
89+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
90+
(except as stated in this section) patent license to make, have made,
91+
use, offer to sell, sell, import, and otherwise transfer the Work,
92+
where such license applies only to those patent claims licensable
93+
by such Contributor that are necessarily infringed by their
94+
Contribution(s) alone or by combination of their Contribution(s)
95+
with the Work to which such Contribution(s) was submitted. If You
96+
institute patent litigation against any entity (including a
97+
cross-claim or counterclaim in a lawsuit) alleging that the Work
98+
or a Contribution incorporated within the Work constitutes direct
99+
or contributory patent infringement, then any patent licenses
100+
granted to You under this License for that Work shall terminate
101+
as of the date such litigation is filed.
102+
103+
4. Redistribution. You may reproduce and distribute copies of the
104+
Work or Derivative Works thereof in any medium, with or without
105+
modifications, and in Source or Object form, provided that You
106+
meet the following conditions:
107+
108+
(a) You must give any other recipients of the Work or
109+
Derivative Works a copy of this License; and
110+
111+
(b) You must cause any modified files to carry prominent notices
112+
stating that You changed the files; and
113+
114+
(c) You must retain, in the Source form of any Derivative Works
115+
that You distribute, all copyright, patent, trademark, and
116+
attribution notices from the Source form of the Work,
117+
excluding those notices that do not pertain to any part of
118+
the Derivative Works; and
119+
120+
(d) If the Work includes a "NOTICE" text file as part of its
121+
distribution, then any Derivative Works that You distribute must
122+
include a readable copy of the attribution notices contained
123+
within such NOTICE file, excluding those notices that do not
124+
pertain to any part of the Derivative Works, in at least one
125+
of the following places: within a NOTICE text file distributed
126+
as part of the Derivative Works; within the Source form or
127+
documentation, if provided along with the Derivative Works; or,
128+
within a display generated by the Derivative Works, if and
129+
wherever such third-party notices normally appear. The contents
130+
of the NOTICE file are for informational purposes only and
131+
do not modify the License. You may add Your own attribution
132+
notices within Derivative Works that You distribute, alongside
133+
or in addition to the NOTICE text from the Work, provided
134+
that such additional attribution notices cannot be construed
135+
as modifying the License.
136+
137+
You may add Your own copyright statement to Your modifications and
138+
may provide additional or different license terms and conditions
139+
for use, reproduction, or distribution of Your modifications, or
140+
for any such Derivative Works as a whole, provided Your use,
141+
reproduction, and distribution of the Work otherwise complies with
142+
the conditions stated in this License.
143+
144+
5. Submission of Contributions. Unless You explicitly state otherwise,
145+
any Contribution intentionally submitted for inclusion in the Work
146+
by You to the Licensor shall be under the terms and conditions of
147+
this License, without any additional terms or conditions.
148+
Notwithstanding the above, nothing herein shall supersede or modify
149+
the terms of any separate license agreement you may have executed
150+
with Licensor regarding such Contributions.
151+
152+
6. Trademarks. This License does not grant permission to use the trade
153+
names, trademarks, service marks, or product names of the Licensor,
154+
except as required for reasonable and customary use in describing the
155+
origin of the Work and reproducing the content of the NOTICE file.
156+
157+
7. Disclaimer of Warranty. Unless required by applicable law or
158+
agreed to in writing, Licensor provides the Work (and each
159+
Contributor provides its Contributions) on an "AS IS" BASIS,
160+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
161+
implied, including, without limitation, any warranties or conditions
162+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
163+
PARTICULAR PURPOSE. You are solely responsible for determining the
164+
appropriateness of using or redistributing the Work and assume any
165+
risks associated with Your exercise of permissions under this License.
166+
167+
8. Limitation of Liability. In no event and under no legal theory,
168+
whether in tort (including negligence), contract, or otherwise,
169+
unless required by applicable law (such as deliberate and grossly
170+
negligent acts) or agreed to in writing, shall any Contributor be
171+
liable to You for damages, including any direct, indirect, special,
172+
incidental, or exemplary damages of any character arising as a
173+
result of this License or out of the use or inability to use the
174+
Work (including but not limited to damages for loss of goodwill,
175+
work stoppage, computer failure or malfunction, or any and all
176+
other commercial damages or losses), even if such Contributor
177+
has been advised of the possibility of such damages.
178+
179+
9. Accepting Warranty or Additional Liability. While redistributing
180+
the Work or Derivative Works thereof, You may choose to offer,
181+
and charge a fee for, acceptance of support, warranty, indemnity,
182+
or other liability obligations and/or rights consistent with this
183+
License. However, in accepting such obligations, You may act only
184+
on your own behalf and on your sole responsibility, not on behalf
185+
of any other Contributor, and only if You agree to indemnify,
186+
defend, and hold each Contributor harmless for any liability
187+
incurred by, or claims asserted against, such Contributor by reason
188+
of your accepting any such warranty or additional liability.
189+
190+
END OF TERMS AND CONDITIONS
191+
192+
APPENDIX: How to apply the Apache License to your work.
193+
194+
To apply the Apache License to your work, attach the following
195+
boilerplate notice, with the fields enclosed by brackets "{}"
196+
replaced with your own identifying information. (Don't include
197+
the brackets!) The text should be enclosed in the appropriate
198+
comment syntax for the file format. We also recommend that a
199+
file or class name and description of purpose be included on the
200+
same "printed page" as the copyright notice for easier
201+
identification within third-party archives.
202+
203+
Copyright {yyyy} {name of copyright owner}
204+
205+
Licensed under the Apache License, Version 2.0 (the "License");
206+
you may not use this file except in compliance with the License.
207+
You may obtain a copy of the License at
208+
209+
http://www.apache.org/licenses/LICENSE-2.0
210+
211+
Unless required by applicable law or agreed to in writing, software
212+
distributed under the License is distributed on an "AS IS" BASIS,
213+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
214+
See the License for the specific language governing permissions and
215+
limitations under the License.
216+
217+
```
218+
219+
The shorter version of license text should be added as a comment to all Salesforce-authored source code and configuration files that support comments. This includes file formats like HTML, CSS, JavaScript, XML, etc. which aren't directly code, but are still critical to your project code. Like:
220+
221+
```
222+
/*
223+
* Copyright (c) 2026, Salesforce, Inc.
224+
* SPDX-License-Identifier: Apache-2
225+
*
226+
* Licensed under the Apache License, Version 2.0 (the "License");
227+
* you may not use this file except in compliance with the License.
228+
* You may obtain a copy of the License at
229+
*
230+
* http://www.apache.org/licenses/LICENSE-2.0
231+
*
232+
* Unless required by applicable law or agreed to in writing, software
233+
* distributed under the License is distributed on an "AS IS" BASIS,
234+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
235+
* See the License for the specific language governing permissions and
236+
* limitations under the License.
237+
*/
238+
```
239+
240+
Note that there are many tools that exist to do this sort of thing in an automated fashion, without having to manually edit every single file in your project. It is highly recommended that you research some of these tools for your particular language / build system.
241+
242+
For sample, demo, and example code, we recommend the [Unlicense](https://opensource.org/license/unlicense/) license. Create a `LICENSE.txt` file containing:
243+
244+
```
245+
This is free and unencumbered software released into the public domain.
246+
247+
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
248+
249+
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
250+
251+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
252+
```
253+
254+
No license header is required for samples, demos, and example code.

0 commit comments

Comments
 (0)