Skip to content

Commit 88e3eac

Browse files
added sdk_contrib (#309)
* added sdk_contrib * more specifics * Update README.md Co-authored-by: Anuraag Agrawal <[email protected]> Co-authored-by: Anuraag Agrawal <[email protected]>
1 parent 0b4a04c commit 88e3eac

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,27 @@ This monorepo hosts the following npm packages for the SDK:
6767
- [aws-xray-sdk-mysql](https://www.npmjs.com/package/aws-xray-sdk-mysql)
6868
- [aws-xray-sdk-postgres](https://www.npmjs.com/package/aws-xray-sdk-postgres)
6969
- [aws-xray-sdk-restify](https://www.npmjs.com/package/aws-xray-sdk-restify)
70+
- [Community contributed packages](https://github.com/aws/aws-xray-sdk-node/tree/master/sdk_contrib)
71+
72+
## Community contributions for new Middleware
73+
If you'd like to add support for a new web framework by writing middleware for X-Ray,
74+
please do so by creating a new package within the `sdk_contrib`
75+
[directory](https://github.com/aws/aws-xray-sdk-node/tree/master/sdk_contrib).
76+
We are not accepting pull requests for first-party packages at this time,
77+
but will be more than happy to host them as community contributions. This means that AWS will:
78+
79+
- Host them in this repository
80+
- Publish them to NPM
81+
- Consider them the officially recommended way of using X-Ray with that framework
82+
- Review & merge pull requests made against them by the community
83+
- Allow issues related to them on this repo for visibility to the community
84+
85+
AWS will not:
86+
87+
- Provide first party support through AWS Forums, AWS customer support, etc for things like questions & debugging help
88+
- Actively develop on them (e.g. if we add a feature to the Express middleware, it will not necessarily be added to middleware in `sdk_contrib`)
89+
90+
## Testing from Source
7091

7192
This repo uses [Lerna](https://lernajs.io) to manage multiple packages. To install Lerna:
7293
```

lerna.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"lerna": "3.15.0",
33
"packages": [
44
".",
5-
"packages/*"
5+
"packages/*",
6+
"sdk_contrib/*"
67
],
78
"version": "independent",
89
"npmClientArgs": [

sdk_contrib/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)