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
+32-15Lines changed: 32 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,17 @@ documentation, we greatly value feedback and contributions from our community.
6
6
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7
7
information to effectively respond to your bug report or contribution.
8
8
9
+
**Please note:** this repository is generated from an internal AWS source of truth, which means we are unable to merge
10
+
pull requests into it directly. We very much still want your input -- see
11
+
[How we handle contributions](#how-we-handle-contributions) for what happens to an issue or pull request you open, and
12
+
how you get credit for a change we adopt.
13
+
9
14
10
15
## Reporting Bugs/Feature Requests
11
16
12
-
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
17
+
We welcome you to use the GitHub issue tracker to report bugs or suggest features. Issues are the most effective way to
18
+
reach us: a feature request that describes your use case can be picked up and implemented, whereas a pull request cannot
19
+
be merged as-is.
13
20
14
21
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15
22
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
@@ -20,25 +27,34 @@ reported the issue. Please try to include as much information as you can. Detail
20
27
* Anything unusual about your environment or deployment
21
28
22
29
23
-
## Contributing via Pull Requests
24
-
This repository contains the source code and examples for the Runtime Interface Emulator. We will accept pull requests on documentation, examples, bug fixes and the Dockerfiles. We will also accept pull requests, issues and feedback on improvements to the Runtime Interface Emulator. However, our priority will be to maintain fidelity with AWS Lambda’s Runtime Interface on the cloud.
30
+
## How we handle contributions
31
+
32
+
This repository contains the source code and examples for the Runtime Interface Emulator. The code here is generated from
33
+
an internal AWS repository, which is the source of truth, and changes flow outward from there. Because of that we cannot
34
+
merge a pull request into this repository, even one we agree with.
25
35
26
-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
36
+
That does not mean we don't want it. Here is what each kind of contribution gets you:
27
37
28
-
1. You are working against the latest source on the *main* branch.
29
-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
30
-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
38
+
***Feature requests and bug reports are welcome, and are the most useful thing you can send us.** Open an issue
39
+
describing the behaviour you want and the use case behind it. Our priority is maintaining fidelity with AWS Lambda's
40
+
Runtime Interface in the cloud, so a clear use case is what lets us weigh a change against that.
41
+
***Pull requests are welcome as a reference.** We read them, and a working patch is often the clearest way to explain a
42
+
proposal. It will not be merged directly. If we adopt your solution, we make the corresponding change in the internal
43
+
repository, and it reaches this repository through the next sync.
44
+
***If we adopt your change, we credit you in the release notes** for the version that ships it.
31
45
32
-
To send us a pull request, please:
46
+
So that we can act on a pull request, please:
33
47
34
-
1. Fork the repository.
35
-
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
36
-
3. Ensure local tests pass through `make integ-tests-and-compile`
37
-
4. Commit to your fork using clear commit messages.
38
-
5. Send us a pull request, answering any default questions in the pull request interface.
48
+
1. Open an issue first to discuss any significant work -- we would hate for your time to be wasted on something we
49
+
cannot take.
50
+
2. Work against the latest source on the *main* branch.
51
+
3. Check existing open, and recently closed, pull requests and issues to make sure someone else hasn't raised it already.
52
+
4. Focus on the specific change you are proposing. If you also reformat all the code, it will be hard for us to see what
53
+
you are actually suggesting.
54
+
5. Ensure local tests pass through `make integ-tests-and-compile`.
39
55
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
40
56
41
-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
57
+
GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
42
58
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
43
59
44
60
@@ -58,4 +74,5 @@ If you discover a potential security issue in this project we ask that you notif
58
74
59
75
## Licensing
60
76
61
-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
77
+
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your
78
+
contribution, including for a pull request we adopt rather than merge.
0 commit comments