Skip to content

Commit 4a8b76a

Browse files
cheungarykcheungaryk
committed
OSS files update
1 parent 44688a8 commit 4a8b76a

2 files changed

Lines changed: 263 additions & 6 deletions

File tree

‎CONTRIBUTING.md‎

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

‎LICENSE.txt‎

Lines changed: 189 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,195 @@
1-
Copyright (c) 2021, Salesforce.com, Inc.
1+
Apache License Version 2.0
2+
3+
Copyright (c) 2025 Salesforce, Inc.
24
All rights reserved.
35

4-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6+
Apache License
7+
Version 2.0, January 2004
8+
http://www.apache.org/licenses/
9+
10+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11+
12+
1. Definitions.
13+
14+
"License" shall mean the terms and conditions for use, reproduction,
15+
and distribution as defined by Sections 1 through 9 of this document.
16+
17+
"Licensor" shall mean the copyright owner or entity authorized by
18+
the copyright owner that is granting the License.
19+
20+
"Legal Entity" shall mean the union of the acting entity and all
21+
other entities that control, are controlled by, or are under common
22+
control with that entity. For the purposes of this definition,
23+
"control" means (i) the power, direct or indirect, to cause the
24+
direction or management of such entity, whether by contract or
25+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
26+
outstanding shares, or (iii) beneficial ownership of such entity.
27+
28+
"You" (or "Your") shall mean an individual or Legal Entity
29+
exercising permissions granted by this License.
30+
31+
"Source" form shall mean the preferred form for making modifications,
32+
including but not limited to software source code, documentation
33+
source, and configuration files.
34+
35+
"Object" form shall mean any form resulting from mechanical
36+
transformation or translation of a Source form, including but
37+
not limited to compiled object code, generated documentation,
38+
and conversions to other media types.
39+
40+
"Work" shall mean the work of authorship, whether in Source or
41+
Object form, made available under the License, as indicated by a
42+
copyright notice that is included in or attached to the work
43+
(an example is provided in the Appendix below).
44+
45+
"Derivative Works" shall mean any work, whether in Source or Object
46+
form, that is based on (or derived from) the Work and for which the
47+
editorial revisions, annotations, elaborations, or other modifications
48+
represent, as a whole, an original work of authorship. For the purposes
49+
of this License, Derivative Works shall not include works that remain
50+
separable from, or merely link (or bind by name) to the interfaces of,
51+
the Work and Derivative Works thereof.
52+
53+
"Contribution" shall mean any work of authorship, including
54+
the original version of the Work and any modifications or additions
55+
to that Work or Derivative Works thereof, that is intentionally
56+
submitted to Licensor for inclusion in the Work by the copyright owner
57+
or by an individual or Legal Entity authorized to submit on behalf of
58+
the copyright owner. For the purposes of this definition, "submitted"
59+
means any form of electronic, verbal, or written communication sent
60+
to the Licensor or its representatives, including but not limited to
61+
communication on electronic mailing lists, source code control systems,
62+
and issue tracking systems that are managed by, or on behalf of, the
63+
Licensor for the purpose of discussing and improving the Work, but
64+
excluding communication that is conspicuously marked or otherwise
65+
designated in writing by the copyright owner as "Not a Contribution."
66+
67+
"Contributor" shall mean Licensor and any individual or Legal Entity
68+
on behalf of whom a Contribution has been received by Licensor and
69+
subsequently incorporated within the Work.
70+
71+
2. Grant of Copyright License. Subject to the terms and conditions of
72+
this License, each Contributor hereby grants to You a perpetual,
73+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74+
copyright license to reproduce, prepare Derivative Works of,
75+
publicly display, publicly perform, sublicense, and distribute the
76+
Work and such Derivative Works in Source or Object form.
77+
78+
3. Grant of Patent License. Subject to the terms and conditions of
79+
this License, each Contributor hereby grants to You a perpetual,
80+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81+
(except as stated in this section) patent license to make, have made,
82+
use, offer to sell, sell, import, and otherwise transfer the Work,
83+
where such license applies only to those patent claims licensable
84+
by such Contributor that are necessarily infringed by their
85+
Contribution(s) alone or by combination of their Contribution(s)
86+
with the Work to which such Contribution(s) was submitted. If You
87+
institute patent litigation against any entity (including a
88+
cross-claim or counterclaim in a lawsuit) alleging that the Work
89+
or a Contribution incorporated within the Work constitutes direct
90+
or contributory patent infringement, then any patent licenses
91+
granted to You under this License for that Work shall terminate
92+
as of the date such litigation is filed.
93+
94+
4. Redistribution. You may reproduce and distribute copies of the
95+
Work or Derivative Works thereof in any medium, with or without
96+
modifications, and in Source or Object form, provided that You
97+
meet the following conditions:
98+
99+
(a) You must give any other recipients of the Work or
100+
Derivative Works a copy of this License; and
101+
102+
(b) You must cause any modified files to carry prominent notices
103+
stating that You changed the files; and
104+
105+
(c) You must retain, in the Source form of any Derivative Works
106+
that You distribute, all copyright, patent, trademark, and
107+
attribution notices from the Source form of the Work,
108+
excluding those notices that do not pertain to any part of
109+
the Derivative Works; and
110+
111+
(d) If the Work includes a "NOTICE" text file as part of its
112+
distribution, then any Derivative Works that You distribute must
113+
include a readable copy of the attribution notices contained
114+
within such NOTICE file, excluding those notices that do not
115+
pertain to any part of the Derivative Works, in at least one
116+
of the following places: within a NOTICE text file distributed
117+
as part of the Derivative Works; within the Source form or
118+
documentation, if provided along with the Derivative Works; or,
119+
within a display generated by the Derivative Works, if and
120+
wherever such third-party notices normally appear. The contents
121+
of the NOTICE file are for informational purposes only and
122+
do not modify the License. You may add Your own attribution
123+
notices within Derivative Works that You distribute, alongside
124+
or as an addendum to the NOTICE text from the Work, provided
125+
that such additional attribution notices cannot be construed
126+
as modifying the License.
127+
128+
You may add Your own copyright statement to Your modifications and
129+
may provide additional or different license terms and conditions
130+
for use, reproduction, or distribution of Your modifications, or
131+
for any such Derivative Works as a whole, provided Your use,
132+
reproduction, and distribution of the Work otherwise complies with
133+
the conditions stated in this License.
134+
135+
5. Submission of Contributions. Unless You explicitly state otherwise,
136+
any Contribution intentionally submitted for inclusion in the Work
137+
by You to the Licensor shall be under the terms and conditions of
138+
this License, without any additional terms or conditions.
139+
Notwithstanding the above, nothing herein shall supersede or modify
140+
the terms of any separate license agreement you may have executed
141+
with Licensor regarding such Contributions.
142+
143+
6. Trademarks. This License does not grant permission to use the trade
144+
names, trademarks, service marks, or product names of the Licensor,
145+
except as required for reasonable and customary use in describing the
146+
origin of the Work and reproducing the content of the NOTICE file.
147+
148+
7. Disclaimer of Warranty. Unless required by applicable law or
149+
agreed to in writing, Licensor provides the Work (and each
150+
Contributor provides its Contributions) on an "AS IS" BASIS,
151+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152+
implied, including, without limitation, any warranties or conditions
153+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154+
PARTICULAR PURPOSE. You are solely responsible for determining the
155+
appropriateness of using or redistributing the Work and assume any
156+
risks associated with Your exercise of permissions under this License.
157+
158+
8. Limitation of Liability. In no event and under no legal theory,
159+
whether in tort (including negligence), contract, or otherwise,
160+
unless required by applicable law (such as deliberate and grossly
161+
negligent acts) or agreed to in writing, shall any Contributor be
162+
liable to You for damages, including any direct, indirect, special,
163+
incidental, or consequential damages of any character arising as a
164+
result of this License or out of the use or inability to use the
165+
Work (including but not limited to damages for loss of goodwill,
166+
work stoppage, computer failure or malfunction, or any and all
167+
other commercial damages or losses), even if such Contributor
168+
has been advised of the possibility of such damages.
169+
170+
9. Accepting Warranty or Additional Liability. While redistributing
171+
the Work or Derivative Works thereof, You may choose to offer,
172+
and charge a fee for, acceptance of support, warranty, indemnity,
173+
or other liability obligations and/or rights consistent with this
174+
License. However, in accepting such obligations, You may act only
175+
on Your own behalf and on Your sole responsibility, not on behalf
176+
of any other Contributor, and only if You agree to indemnify,
177+
defend, and hold each Contributor harmless for any liability
178+
incurred by, or claims asserted against, such Contributor by reason
179+
of your accepting any such warranty or additional liability.
180+
181+
END OF TERMS AND CONDITIONS
5182

6-
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
183+
Copyright 2025 Salesforce, Inc.
7184

8-
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
185+
Licensed under the Apache License, Version 2.0 (the "License");
186+
you may not use this file except in compliance with the License.
187+
You may obtain a copy of the License at
9188

10-
* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
189+
http://www.apache.org/licenses/LICENSE-2.0
11190

12-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
191+
Unless required by applicable law or agreed to in writing, software
192+
distributed under the License is distributed on an "AS IS" BASIS,
193+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
194+
See the License for the specific language governing permissions and
195+
limitations under the License.

0 commit comments

Comments
 (0)