You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-19Lines changed: 26 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,26 +13,29 @@ The intent and goal of open sourcing this project is to increase the contributor
13
13
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
14
14
15
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.
16
+
17
+
- 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,
18
+
[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
19
+
be reviewed.
20
+
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
21
+
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
22
+
- Include tests that isolate the bug and verifies that it was fixed.
22
23
23
24
### 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.
25
+
26
+
- 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).
27
+
- Issues that have been identified as a feature request will be labelled `enhancement`.
28
+
- If you'd like to implement the new feature, please wait for feedback from the project
29
+
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
30
+
not align well with the project objectives at the time.
29
31
30
32
### 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.
33
+
34
+
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
35
+
alternative implementation of something that may have advantages over the way its currently
36
+
done, or you have any other change, we would be happy to hear about it!
37
+
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
38
+
- 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
39
37
40
If you're new to our project and looking for some way to make your first contribution, look for
38
41
Issues labelled `good first contribution`.
@@ -56,9 +59,9 @@ Issues labelled `good first contribution`.
56
59
57
60
# Creating a Pull Request
58
61
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
+
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).
63
+
2.**Clone** the forked repo to your machine.
64
+
3.**Create** a new branch to contain your work (e.g. `git br fix-issue-11`)
62
65
4.**Commit** changes to your own branch.
63
66
5.**Push** your work back up to your fork. (e.g. `git push fix-issue-11`)
64
67
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.
@@ -67,17 +70,21 @@ Issues labelled `good first contribution`.
67
70
> **NOTE**: Be sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request.
68
71
69
72
# Contributor License Agreement ("CLA")
73
+
70
74
In order to accept your pull request, we need you to submit a CLA. You only need
71
75
to do this once to work on any of Salesforce's open source projects.
72
76
73
77
Complete your CLA here: <https://cla.salesforce.com/sign-cla>
74
78
75
79
# Issues
80
+
76
81
We use GitHub issues to track public bugs. Please ensure your description is
77
82
clear and has sufficient instructions to be able to reproduce the issue.
78
83
79
84
# Code of Conduct
85
+
80
86
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
81
87
82
88
# License
89
+
83
90
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