Skip to content

Commit 6963a35

Browse files
authored
Reformat line wrapping in documentation (aws#112)
Reformatted line wrapping of documentation to 80 characters. Also updated changelog to move features to the top and bug fixes to the bottom and used code fences and appropriate indenting where applicable.
1 parent 9461d7c commit 6963a35

File tree

9 files changed

+958
-390
lines changed

9 files changed

+958
-390
lines changed

CHANGELOG.md

Lines changed: 80 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -16,50 +16,88 @@ permissions and limitations under the License.
1616

1717
## Release v1.2.0 (Release Date: TBD)
1818

19-
This release contains new support for Apollo Server integration.
20-
21-
### Bug Fixes
22-
23-
* Don't cast integers to floats in Neptune schema ([#62](https://github.com/aws/amazon-neptune-for-graphql/pull/62))
24-
* Fix query from AppSync with an empty filter object ([#61](https://github.com/aws/amazon-neptune-for-graphql/pull/61))
25-
* Retain numeric parameter value type when creating open cypher query ([#63](https://github.com/aws/amazon-neptune-for-graphql/pull/63))
26-
* Fixed bug with ID argument type conversion and added Apollo arguments to help menu ([#74](https://github.com/aws/amazon-neptune-for-graphql/pull/74))
27-
* Upgraded axios and babel versions to fix security warnings ([#90](https://github.com/aws/amazon-neptune-for-graphql/pull/90))
28-
* Fixed failing integration test by excluding `node_modules` from Apollo zip ([#94](https://github.com/aws/amazon-neptune-for-graphql/pull/94))
29-
* Fixed enum types in schema to be included in input types ([#95](https://github.com/aws/amazon-neptune-for-graphql/pull/95))
30-
* Fixed bug where id fields without @id directives are not accounted for ([#96](https://github.com/aws/amazon-neptune-for-graphql/pull/96))
31-
* Fixed custom scalar types in schema to be included in input types ([#97](https://github.com/aws/amazon-neptune-for-graphql/pull/97))
32-
* Fixed queries generated from an input schema which retrieve an array to have an option parameter with limit ([#97](https://github.com/aws/amazon-neptune-for-graphql/pull/97))
33-
* Fixed nested edge subqueries to return an empty array if no results were found (([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
34-
* Fixed usage of variables with nested edge subqueries (([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
35-
* Fixed cdk output file to contain previously missing files that were necessary to execute the lambda resolver (([#106](https://github.com/aws/amazon-neptune-for-graphql/pull/106))
36-
* Fixed resolution of nested variables in selection set arguments (([#108](https://github.com/aws/amazon-neptune-for-graphql/pull/108))
37-
* Changed resolver to use `graphql` `parse` instead of `graphql-tag` `gql` to avoid stale values due to caching (([#109](https://github.com/aws/amazon-neptune-for-graphql/pull/109))
38-
39-
4019
### Features
4120

42-
* Support output of zip package of Apollo Server artifacts (([#70](https://github.com/aws/amazon-neptune-for-graphql/pull/70)), ([#72](https://github.com/aws/amazon-neptune-for-graphql/pull/72)), ([#73](https://github.com/aws/amazon-neptune-for-graphql/pull/73)), ([#75](https://github.com/aws/amazon-neptune-for-graphql/pull/75)), ([#76](https://github.com/aws/amazon-neptune-for-graphql/pull/76)))
43-
* Allow filtering using string comparison operators `eq`, `contains`, `startsWith`, `endsWith` (([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
44-
* Added pagination support through the addition of an `offset` argument in query options which can be used in combination with the existing `limit` (([#102](https://github.com/aws/amazon-neptune-for-graphql/pull/102))
45-
* Added support for queries with sorting ([#105](https://github.com/aws/amazon-neptune-for-graphql/pull/105))
46-
21+
* Support output of zip package of Apollo Server
22+
artifacts ([#70](https://github.com/aws/amazon-neptune-for-graphql/pull/70), [#72](https://github.com/aws/amazon-neptune-for-graphql/pull/72), [#73](https://github.com/aws/amazon-neptune-for-graphql/pull/73), [#75](https://github.com/aws/amazon-neptune-for-graphql/pull/75), [#76](https://github.com/aws/amazon-neptune-for-graphql/pull/76))
23+
* Allow filtering using string comparison operators `eq`, `contains`,
24+
`startsWith`,
25+
`endsWith` ([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
26+
* Added pagination support through the addition of an `offset` argument in query
27+
options which can be used in combination with the existing
28+
`limit` ([#102](https://github.com/aws/amazon-neptune-for-graphql/pull/102))
29+
* Added support for queries with
30+
sorting ([#105](https://github.com/aws/amazon-neptune-for-graphql/pull/105))
4731

4832
### Improvements
4933

50-
* Increased graphdb.js test coverage using sample data ([#53](https://github.com/aws/amazon-neptune-for-graphql/pull/53))
51-
* Saved the neptune schema to file early so that it can be used for troubleshooting ([#56](https://github.com/aws/amazon-neptune-for-graphql/pull/56))
52-
* Alias edges with same label as a node ([#57](https://github.com/aws/amazon-neptune-for-graphql/pull/57))
53-
* Cap concurrent requests to get Neptune schema ([#58](https://github.com/aws/amazon-neptune-for-graphql/pull/58))
54-
* Honour @id directive on type fields ([#60](https://github.com/aws/amazon-neptune-for-graphql/pull/60))
55-
* Changed lambda template to use ECMAScripts modules ([#68](https://github.com/aws/amazon-neptune-for-graphql/pull/68))
56-
* Add template file missing from packaging ([#71](https://github.com/aws/amazon-neptune-for-graphql/pull/71))
57-
* Separated graphQL schema from resolver template ([#79](https://github.com/aws/amazon-neptune-for-graphql/pull/79))
58-
* Added unit tests for resolver and moved resolver integration tests to be unit tests ([#83](https://github.com/aws/amazon-neptune-for-graphql/pull/83))
59-
* Set limit on the expensive query which is retrieving distinct to and from labels for edges ([#89](https://github.com/aws/amazon-neptune-for-graphql/pull/89))
60-
* Added distinct input types for create and update mutations ([#93](https://github.com/aws/amazon-neptune-for-graphql/pull/93))
61-
* Enabled mutations for the Apollo Server ([#98](https://github.com/aws/amazon-neptune-for-graphql/pull/98))
62-
* Refactored integration tests to be less vulnerable to resolver logic changes ([#99](https://github.com/aws/amazon-neptune-for-graphql/pull/99))
63-
* Enabled usage of query fragments with Apollo Server ([#103](https://github.com/aws/amazon-neptune-for-graphql/pull/103))
64-
* Compressed resolver schema file and moved schema initialization outside of event handlers to improve performance ([#111](https://github.com/aws/amazon-neptune-for-graphql/pull/111))
65-
* Updated and proofread outdated documentation ([#107](https://github.com/aws/amazon-neptune-for-graphql/pull/107))
34+
* Increased graphdb.js test coverage using sample
35+
data ([#53](https://github.com/aws/amazon-neptune-for-graphql/pull/53))
36+
* Saved the neptune schema to file early so that it can be used for
37+
troubleshooting ([#56](https://github.com/aws/amazon-neptune-for-graphql/pull/56))
38+
* Alias edges with same label as a
39+
node ([#57](https://github.com/aws/amazon-neptune-for-graphql/pull/57))
40+
* Cap concurrent requests to get Neptune
41+
schema ([#58](https://github.com/aws/amazon-neptune-for-graphql/pull/58))
42+
* Honour @id directive on type
43+
fields ([#60](https://github.com/aws/amazon-neptune-for-graphql/pull/60))
44+
* Changed lambda template to use ECMAScripts
45+
modules ([#68](https://github.com/aws/amazon-neptune-for-graphql/pull/68))
46+
* Add template file missing from
47+
packaging ([#71](https://github.com/aws/amazon-neptune-for-graphql/pull/71))
48+
* Separated graphQL schema from resolver
49+
template ([#79](https://github.com/aws/amazon-neptune-for-graphql/pull/79))
50+
* Added unit tests for resolver and moved resolver integration tests to be unit
51+
tests ([#83](https://github.com/aws/amazon-neptune-for-graphql/pull/83))
52+
* Set limit on the expensive query which is retrieving distinct to and from
53+
labels for
54+
edges ([#89](https://github.com/aws/amazon-neptune-for-graphql/pull/89))
55+
* Added distinct input types for create and update
56+
mutations ([#93](https://github.com/aws/amazon-neptune-for-graphql/pull/93))
57+
* Enabled mutations for the Apollo
58+
Server ([#98](https://github.com/aws/amazon-neptune-for-graphql/pull/98))
59+
* Refactored integration tests to be less vulnerable to resolver logic
60+
changes ([#99](https://github.com/aws/amazon-neptune-for-graphql/pull/99))
61+
* Enabled usage of query fragments with Apollo
62+
Server ([#103](https://github.com/aws/amazon-neptune-for-graphql/pull/103))
63+
* Compressed resolver schema file and moved schema initialization outside of
64+
event handlers to improve
65+
performance ([#111](https://github.com/aws/amazon-neptune-for-graphql/pull/111))
66+
* Updated and proofread outdated
67+
documentation ([#112](https://github.com/aws/amazon-neptune-for-graphql/pull/107), [#107](https://github.com/aws/amazon-neptune-for-graphql/pull/112))
68+
69+
### Bug Fixes
70+
71+
* Don't cast integers to floats in Neptune
72+
schema ([#62](https://github.com/aws/amazon-neptune-for-graphql/pull/62))
73+
* Fix query from AppSync with an empty filter
74+
object ([#61](https://github.com/aws/amazon-neptune-for-graphql/pull/61))
75+
* Retain numeric parameter value type when creating open cypher
76+
query ([#63](https://github.com/aws/amazon-neptune-for-graphql/pull/63))
77+
* Fixed bug with ID argument type conversion and added Apollo arguments to help
78+
menu ([#74](https://github.com/aws/amazon-neptune-for-graphql/pull/74))
79+
* Upgraded axios and babel versions to fix security
80+
warnings ([#90](https://github.com/aws/amazon-neptune-for-graphql/pull/90))
81+
* Fixed failing integration test by excluding `node_modules` from Apollo
82+
zip ([#94](https://github.com/aws/amazon-neptune-for-graphql/pull/94))
83+
* Fixed enum types in schema to be included in input
84+
types ([#95](https://github.com/aws/amazon-neptune-for-graphql/pull/95))
85+
* Fixed bug where id fields without @id directives are not accounted
86+
for ([#96](https://github.com/aws/amazon-neptune-for-graphql/pull/96))
87+
* Fixed custom scalar types in schema to be included in input
88+
types ([#97](https://github.com/aws/amazon-neptune-for-graphql/pull/97))
89+
* Fixed queries generated from an input schema which retrieve an array to have
90+
an option parameter with
91+
limit ([#97](https://github.com/aws/amazon-neptune-for-graphql/pull/97))
92+
* Fixed nested edge subqueries to return an empty array if no results were
93+
found ([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
94+
* Fixed usage of variables with nested edge
95+
subqueries ([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
96+
* Fixed cdk output file to contain previously missing files that were necessary
97+
to execute the lambda
98+
resolver ([#106](https://github.com/aws/amazon-neptune-for-graphql/pull/106))
99+
* Fixed resolution of nested variables in selection set
100+
arguments ([#108](https://github.com/aws/amazon-neptune-for-graphql/pull/108))
101+
* Changed resolver to use `graphql` `parse` instead of `graphql-tag` `gql` to
102+
avoid stale values due to
103+
caching ([#109](https://github.com/aws/amazon-neptune-for-graphql/pull/109))

CODE_OF_CONDUCT.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
## Code of Conduct
2-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
2+
3+
This project has adopted
4+
the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
5+
For more information see
6+
the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
47
opensource-codeofconduct@amazon.com with any additional questions or comments.

CONTRIBUTING.md

Lines changed: 42 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,78 @@
11
# Contributing Guidelines
22

3-
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4-
documentation, we greatly value feedback and contributions from our community.
5-
6-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7-
information to effectively respond to your bug report or contribution.
3+
Thank you for your interest in contributing to our project. Whether it's a bug
4+
report, new feature, correction, or additional documentation, we greatly value
5+
feedback and contributions from our community.
86

7+
Please read through this document before submitting any issues or pull requests
8+
to ensure we have all the necessary information to effectively respond to your
9+
bug report or contribution.
910

1011
## Reporting Bugs/Feature Requests
1112

12-
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13+
We welcome you to use the GitHub issue tracker to report bugs or suggest
14+
features.
1315

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16+
When filing an issue, please check existing open, or recently closed, issues to
17+
make sure somebody else hasn't already reported the issue. Please try to include
18+
as much information as you can. Details like these are incredibly useful:
1619

1720
* A reproducible test case or series of steps
1821
* The version of our code being used
1922
* Any modifications you've made relevant to the bug
2023
* Anything unusual about your environment or deployment
2124

22-
2325
## Contributing via Pull Requests
24-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
26+
27+
Contributions via pull requests are much appreciated. Before sending us a pull
28+
request, please ensure that:
2529

2630
1. You are working against the latest source on the *main* branch.
27-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
31+
2. You check existing open, and recently merged, pull requests to make sure
32+
someone else hasn't addressed the problem already.
33+
3. You open an issue to discuss any significant work - we would hate for your
34+
time to be wasted.
2935

3036
To send us a pull request, please:
3137

3238
1. Fork the repository.
33-
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.
39+
2. Modify the source; please focus on the specific change you are contributing.
40+
If you also reformat all the code, it will be hard for us to focus on your
41+
change.
3442
3. Ensure local tests pass.
3543
4. Commit to your fork using clear commit messages.
36-
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
44+
5. Send us a pull request, answering any default questions in the pull request
45+
interface.
46+
6. Pay attention to any automated CI failures reported in the pull request, and
47+
stay involved in the conversation.
3848

39-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
49+
GitHub provides additional document
50+
on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4051
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4152

42-
4353
## Finding contributions to work on
44-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
4554

55+
Looking at the existing issues is a great way to find something to contribute
56+
on. As our projects, by default, use the default GitHub issue labels (
57+
enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at
58+
any 'help wanted' issues is a great place to start.
4659

4760
## Code of Conduct
48-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50-
opensource-codeofconduct@amazon.com with any additional questions or comments.
5161

62+
This project has adopted
63+
the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
64+
For more information see
65+
the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
66+
opensource-codeofconduct@amazon.com with any additional questions or comments.
5267

5368
## Security issue notifications
54-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
5569

70+
If you discover a potential security issue in this project we ask that you
71+
notify AWS/Amazon Security via
72+
our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
73+
Please do **not** create a public github issue.
5674

5775
## Licensing
5876

59-
See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
77+
See the [LICENSE](./LICENSE.txt) file for our project's licensing. We will ask
78+
you to confirm the licensing of your contribution.

0 commit comments

Comments
 (0)