-
-
Notifications
You must be signed in to change notification settings - Fork 905
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added Style Guide and Test Writing Guide (#1897)
The Style Guide moved into the Documentation site for better visibility. Removed lots of discussion around topics that are already enforced by the formatter/linter. Added new advice regarding a variety of topics. The Test Writing Guide discusses how to write tests for Flame, and what kinds of tests are available.
- Loading branch information
Showing
8 changed files
with
436 additions
and
212 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,45 +1,49 @@ | ||
# Description | ||
|
||
<!-- Provide a description of what this PR is doing. | ||
<!-- | ||
Provide a description of what this PR is doing. | ||
If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, | ||
and what motivated the change. If this is a breaking change, specify explicitly which APIs have been | ||
changed. --> | ||
and what motivated the change. If this is a breaking change, specify explicitly which APIs were | ||
changed. | ||
--> | ||
|
||
## Checklist | ||
|
||
<!-- Before you create this PR confirm that it meets all requirements listed below by checking the | ||
relevant checkboxes (`[x]`). This will ensure a smooth and quick review process. --> | ||
## Checklist | ||
<!-- | ||
Before you create this PR confirm that it meets all requirements listed below by checking the | ||
relevant checkboxes with `[x]`. If some checkbox is not applicable, mark it as `[-]`. | ||
--> | ||
|
||
- [ ] The title of my PR starts with a [Conventional Commit] prefix (`fix:`, `feat:`, `docs:` etc). | ||
- [ ] I have read the [Contributor Guide] and followed the process outlined for submitting PRs. | ||
- [ ] I have followed the [Contributor Guide] when preparing my PR. | ||
- [ ] I have updated/added tests for ALL new/updated/fixed functionality. | ||
- [ ] I have updated/added relevant documentation in `docs` and added dartdoc comments with `///`. | ||
- [ ] I have updated/added relevant examples in `examples`. | ||
- [ ] I have updated/added relevant examples in `examples` or `docs`. | ||
|
||
## Breaking Change | ||
|
||
<!-- Does your PR require Flame users to manually update their apps to accommodate your change? | ||
## Breaking Change? | ||
<!-- | ||
Would your PR require Flame users to update their apps following your change? | ||
If the PR is a breaking change this should be indicated with suffix "!" | ||
(for example, `feat!:`, `fix!:`). See [Conventional Commit] for details. | ||
--> | ||
|
||
- [ ] Yes, this is a breaking change. | ||
- [ ] No, this is *not* a breaking change. | ||
If yes, then the title of the PR should include "!" (for example, `feat!:`, `fix!:`). See | ||
[Conventional Commit] for details. Also, for a breaking PR uncomment and fill in the "Migration | ||
instructions" section below. | ||
<!-- ### Migration instructions | ||
### Migration instructions | ||
If the PR is breaking, uncomment this header and add instructions for how to migrate from the | ||
currently released version to the new proposed way. | ||
--> | ||
|
||
## Related Issues | ||
- [ ] Yes, this PR is a breaking change. | ||
- [ ] No, this PR is not a breaking change. | ||
|
||
<!-- Provide a list of issues related to this PR from the [issue database]. | ||
Indicate which of these issues are resolved or fixed by this PR, i.e. Fixes #xxxx* !--> | ||
|
||
## Related Issues | ||
<!-- | ||
Indicate which issues this PR resolves, if any. For example: | ||
Closes #1234 | ||
!--> | ||
|
||
<!-- Links --> | ||
[issue database]: https://github.com/flame-engine/flame/issues | ||
[Contributor Guide]: https://github.com/flame-engine/flame/blob/main/CONTRIBUTING.md | ||
[Flame Style Guide]: https://github.com/flame-engine/flame/blob/main/STYLEGUIDE.md | ||
[Conventional Commit]: https://conventionalcommits.org |
This file contains 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
This file was deleted.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,9 @@ | ||
# Development | ||
|
||
```{toctree} | ||
Documentation <documentation.md> | ||
:maxdepth: 2 | ||
Documentation <documentation.md> | ||
Style Guide <style_guide.md> | ||
Tests Guide <testing_guide.md> | ||
``` |
Oops, something went wrong.