Skip to content

Commit e772ab7

Browse files
committed
2 parents ccf6d2a + 238f9a1 commit e772ab7

File tree

6 files changed

+658
-0
lines changed

6 files changed

+658
-0
lines changed

CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Comment line immediately above ownership line is reserved for related other information. Please be careful while editing.
2+
#ECCN:Open Source
3+
#GUSINFO:Open Source,Open Source Workflow

CODE_OF_CONDUCT.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Salesforce Open Source Community Code of Conduct
2+
3+
## About the Code of Conduct
4+
5+
Equality is a core value at Salesforce. We believe a diverse and inclusive
6+
community fosters innovation and creativity, and are committed to building a
7+
culture where everyone feels included.
8+
9+
Salesforce open-source projects are committed to providing a friendly, safe, and
10+
welcoming environment for all, regardless of gender identity and expression,
11+
sexual orientation, disability, physical appearance, body size, ethnicity, nationality,
12+
race, age, religion, level of experience, education, socioeconomic status, or
13+
other similar personal characteristics.
14+
15+
The goal of this code of conduct is to specify a baseline standard of behavior so
16+
that people with different social values and communication styles can work
17+
together effectively, productively, and respectfully in our open source community.
18+
It also establishes a mechanism for reporting issues and resolving conflicts.
19+
20+
All questions and reports of abusive, harassing, or otherwise unacceptable behavior
21+
in a Salesforce open-source project may be reported by contacting the Salesforce
22+
Open Source Conduct Committee at [email protected].
23+
24+
## Our Pledge
25+
26+
In the interest of fostering an open and welcoming environment, we as
27+
contributors and maintainers pledge to making participation in our project and
28+
our community a harassment-free experience for everyone, regardless of gender
29+
identity and expression, sexual orientation, disability, physical appearance,
30+
body size, ethnicity, nationality, race, age, religion, level of experience, education,
31+
socioeconomic status, or other similar personal characteristics.
32+
33+
## Our Standards
34+
35+
Examples of behavior that contributes to creating a positive environment
36+
include:
37+
38+
* Using welcoming and inclusive language
39+
* Being respectful of differing viewpoints and experiences
40+
* Gracefully accepting constructive criticism
41+
* Focusing on what is best for the community
42+
* Showing empathy toward other community members
43+
44+
Examples of unacceptable behavior by participants include:
45+
46+
* The use of sexualized language or imagery and unwelcome sexual attention or
47+
advances
48+
* Personal attacks, insulting/derogatory comments, or trolling
49+
* Public or private harassment
50+
* Publishing, or threatening to publish, others' private information—such as
51+
a physical or electronic address—without explicit permission
52+
* Other conduct which could reasonably be considered inappropriate in a
53+
professional setting
54+
* Advocating for or encouraging any of the above behaviors
55+
56+
## Our Responsibilities
57+
58+
Project maintainers are responsible for clarifying the standards of acceptable
59+
behavior and are expected to take appropriate and fair corrective action in
60+
response to any instances of unacceptable behavior.
61+
62+
Project maintainers have the right and responsibility to remove, edit, or
63+
reject comments, commits, code, wiki edits, issues, and other contributions
64+
that are not aligned with this Code of Conduct, or to ban temporarily or
65+
permanently any contributor for other behaviors that they deem inappropriate,
66+
threatening, offensive, or harmful.
67+
68+
## Scope
69+
70+
This Code of Conduct applies both within project spaces and in public spaces
71+
when an individual is representing the project or its community. Examples of
72+
representing a project or community include using an official project email
73+
address, posting via an official social media account, or acting as an appointed
74+
representative at an online or offline event. Representation of a project may be
75+
further defined and clarified by project maintainers.
76+
77+
## Enforcement
78+
79+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
80+
reported by contacting the Salesforce Open Source Conduct Committee
81+
at [email protected]. All complaints will be reviewed and investigated
82+
and will result in a response that is deemed necessary and appropriate to the
83+
circumstances. The committee is obligated to maintain confidentiality with
84+
regard to the reporter of an incident. Further details of specific enforcement
85+
policies may be posted separately.
86+
87+
Project maintainers who do not follow or enforce the Code of Conduct in good
88+
faith may face temporary or permanent repercussions as determined by other
89+
members of the project's leadership and the Salesforce Open Source Conduct
90+
Committee.
91+
92+
## Attribution
93+
94+
This Code of Conduct is adapted from the [Contributor Covenant][contributor-covenant-home],
95+
version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html.
96+
It includes adaptions and additions from [Go Community Code of Conduct][golang-coc],
97+
[CNCF Code of Conduct][cncf-coc], and [Microsoft Open Source Code of Conduct][microsoft-coc].
98+
99+
This Code of Conduct is licensed under the [Creative Commons Attribution 3.0 License][cc-by-3-us].
100+
101+
[contributor-covenant-home]: https://www.contributor-covenant.org (https://www.contributor-covenant.org/)
102+
[golang-coc]: https://golang.org/conduct
103+
[cncf-coc]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
104+
[microsoft-coc]: https://opensource.microsoft.com/codeofconduct/
105+
[cc-by-3-us]: https://creativecommons.org/licenses/by/3.0/us/

CONTRIBUTING.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing Guide For Heroku AppLink Pattern: API Access - Node.js
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 {PROJECT}. 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//heroku-reference-apps/heroku-applink-pattern-api-access-nodejs/issues), and if it isn't already tracked,
17+
[create a new issue](https://github.com//heroku-reference-apps/heroku-applink-pattern-api-access-nodejs/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//heroku-reference-apps/heroku-applink-pattern-api-access-nodejs/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//heroku-reference-apps/heroku-applink-pattern-api-access-nodejs/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+
# Contributor License Agreement ("CLA")
70+
In order to accept your pull request, we need you to submit a CLA. You only need
71+
to do this once to work on any of Salesforce's open source projects.
72+
73+
Complete your CLA here: <https://cla.salesforce.com/sign-cla>
74+
75+
# Issues
76+
We use GitHub issues to track public bugs. Please ensure your description is
77+
clear and has sufficient instructions to be able to reproduce the issue.
78+
79+
# Code of Conduct
80+
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
81+
82+
# License
83+
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)