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
+5-24Lines changed: 5 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,46 +1,27 @@
1
-
*This is a suggested `CONTRIBUTING.md` file template for use by open sourced Salesforce projects. The main goal of this file is to make clear the intents and expectations that end-users may have regarding this project and how/if to engage with it. Adjust as needed (especially look for `{project_slug}` which refers to the org and repo name of your project) and remove this paragraph before committing to your repo.*
2
-
3
-
# Contributing Guide For {NAME OF PROJECT}
1
+
# Contributing Guide For Heroku AppLink Pattern: API Access - Node.js
4
2
5
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.
6
4
7
5
# Governance Model
8
-
> Pick the most appropriate one
9
-
10
-
## Community Based
11
-
12
-
The intent and goal of open sourcing this project is to increase the contributor and user base. The governance model is one where new project leads (`admins`) will be added to the project based on their contributions and efforts, a so-called "do-acracy" or "meritocracy" similar to that used by all Apache Software Foundation projects.
13
-
14
-
> or
15
6
16
7
## Salesforce Sponsored
17
8
18
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.
19
10
20
-
> or
21
-
22
-
## Published but not supported
23
-
24
-
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.
25
-
26
-
# Getting started
27
-
28
-
Please join the community on {Here list Slack channels, Email lists, Glitter, Discord, etc... links}. Also please make sure to take a look at the project [roadmap](ROADMAP.md) to see where are headed.
29
-
30
11
# Issues, requests & ideas
31
12
32
13
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
33
14
34
15
### Bug Reports and Fixes
35
-
- If you find a bug, please search for it in the [Issues](https://github.com/{project_slug}/issues), and if it isn't already tracked,
36
-
[create a new issue](https://github.com/{project_slug}/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
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
37
18
be reviewed.
38
19
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
39
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.
40
21
- Include tests that isolate the bug and verifies that it was fixed.
41
22
42
23
### New Features
43
-
- 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/{project_slug}/issues/new).
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).
44
25
- Issues that have been identified as a feature request will be labelled `enhancement`.
45
26
- If you'd like to implement the new feature, please wait for feedback from the project
46
27
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
@@ -51,7 +32,7 @@ Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
51
32
alternative implementation of something that may have advantages over the way its currently
52
33
done, or you have any other change, we would be happy to hear about it!
53
34
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
54
-
- If not, [open an Issue](https://github.com/{project_slug}/issues/new) to discuss the idea first.
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.
55
36
56
37
If you're new to our project and looking for some way to make your first contribution, look for
0 commit comments