Skip to content

Commit 5d17480

Browse files
committed
Update CONTRIBUTING
- Break lines at 80 - Remove unused cross language type mapping
1 parent c980713 commit 5d17480

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,37 @@ For general guidance on contributing to Cucumber, see https://github.com/cucumbe
44

55
## Adding or changing query methods
66

7-
This is a polyglot repo with several languages adhering to a common suite of acceptance tests. A change should be made consistently across all languages. Currently, the list is:
7+
This is a polyglot repo with several languages adhering to a common suite of
8+
acceptance tests. A change should be made consistently across all languages.
9+
Currently, the list is:
810

911
- Java (reference)
1012
- JavaScript
1113
- C# (.NET)
1214

13-
Java is the reference implementation in the sense that it is responsible for generating the fixtures that are used in the acceptance tests to verify all implementations.
15+
Java is the reference implementation in the sense that it is responsible for
16+
generating the fixtures that are used in the acceptance tests to verify all
17+
implementations.
1418

1519
So your playbook for adding a method would be something like:
1620

1721
1. Add the method in `Query.Java` with test(s) in `QueryTest.java`
18-
2. Extend `QueryAcceptanceTest.java` to include verifications for the new method
19-
3. Run `QueryAcceptanceTest::updateExpectedQueryResultFiles` to regenerate the fixtures
22+
2. Extend `QueryAcceptanceTest.java` to include verifications for the new
23+
method
24+
3. Run `QueryAcceptanceTest::updateExpectedQueryResultFiles` to regenerate the
25+
fixtures
2026
4. Implement other languages
2127

2228
## Types
2329

24-
Choosing which type to use in another language based on what we did in Java is an inexact science. This table defines all the decisions we've made so far:
30+
Choosing which type to use in another language based on what we did in Java is
31+
an inexact science. This table defines all the decisions we've made so far:
2532

2633
| Java | JavaScript | C# |
2734
|---------------------|-------------------------|-------------------------|
2835
| `Optional<T>` | `T \| undefined`[^1] | `T?` |
2936
| `List<T>` | `ReadonlyArray<T>` | `List<T>` |
3037
| `Map<K, V>` | `Map<K, V>` | `Dictionary<K, V>` |
3138
| `Map<K, V>` | `Record<K, V>` | `Dictionary<K, V>` |
32-
| `List<Entry<T, V>>` | `ReadonlyArray<[T, V]>` | `List<Entry<T, V>>` |
3339

3440
[^1]: See <https://github.com/sindresorhus/meta/discussions/7>

0 commit comments

Comments
 (0)