docs: update CONTRIBUTING.md with new guidelines and clarifications #2324
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Unclear distinction between inspect and assert_ usageCategory // Instead of: assert(result == expected)
// Use: inspect(result, expected) // Shows actual values on failure
// Exception: Use assert_ in loops where snapshot testing isn't practical
for i in range(0, 10) { assert_(i >= 0) }
```'
**Reasoning**
The current text doesn't clearly explain when to use each assertion type or demonstrate their differences, which could lead to inconsistent testing practices
</details>
<details>
<summary> Typo in documentation </summary>
**Category**
Maintainability
**Code Snippet**
can be updated easilly
**Recommendation**
Fix spelling to 'easily'
**Reasoning**
Correct spelling improves documentation quality and professionalism
</details>
<details>
<summary> Vague guidance on API additions </summary>
**Category**
Maintainability
**Code Snippet**
If the new API can be composed with existing APIs without loosing efficiency
**Recommendation**
Provide concrete criteria: 'If the new API can be composed with existing APIs without performance overhead (i.e., no additional allocations or O(n) complexity increase), prefer composition over new implementations. Example:
```moonbit
// Instead of adding new API: def filter_map(f)
// Use existing: arr.filter(f).map(g) // If performance is equivalent
```'
**Reasoning**
Clear examples and specific criteria help contributors make better decisions about API additions
</details> |
Pull Request Test Coverage Report for Build 7490Details
💛 - Coveralls |
Closed
42e4c0d to
52906d8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.