Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 5c4fd81

Browse files
committedMar 10, 2023
chore: add issue templates
1 parent bdb57e0 commit 5c4fd81

File tree

5 files changed

+64
-1
lines changed

5 files changed

+64
-1
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help improve Motion Canvas
4+
title: ''
5+
labels: bug
6+
assignees: ksassnowski
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of what the bug is.
11+
12+
**Reproduction**
13+
Please include a link to a minimal repository that reproduces the issue.
14+
15+
**Expected behavior**
16+
If applicable, a clear and concise description of what you expected to happen.
17+
18+
**Package versions (please complete the following information):**
19+
20+
- core: [e.g. 1.0.0]
21+
22+
**Additional context**
23+
Add any other context about the problem here.
+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Documentation
3+
about: Report an issue or suggest improvements for documentation
4+
title: ''
5+
labels: documentation
6+
assignees: ksassnowski
7+
---
8+
9+
**Description**
10+
A clear and concise description of what the issue is.
11+
How can it be improved?
+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for Motion Canvas
4+
title: ''
5+
labels: enhancement
6+
assignees: ksassnowski
7+
---
8+
9+
**Description**
10+
A clear and concise description of why the feature is needed.
11+
What problem does it aim to fix?
12+
What benefits does it bring?
13+
14+
**Proposed solution**
15+
A clear and concise description of how the feature would work.
16+
If applicable, provide an example of the API and how it would be used.
17+
18+
**Considered alternatives**
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
**Additional context**
22+
Add any other context or screenshots about the feature request here.

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Roach follows [semantic versioning][semver].
4747
```shell
4848
git checkout -b my-fix-branch main
4949
```
50-
3. Update the code.
50+
3. Update the code. **Make sure that all your changes are covered by tests.**
5151
4. Commit your changes using a **descriptive commit message** that follows the
5252
[Angular Commit Message Conventions][commit-format].
5353
```shell

‎README.md

+7
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ composer require roach-php/core
3535

3636
The full documentation can be found [here](https://roach-php.dev).
3737

38+
## Contributing
39+
40+
Please read our [Contribution Guide][contribution-guide] before opening issues
41+
or pull requests.
42+
3843
## Credits
3944

4045
- [Kai Sassnowski](https://github.com/ksassnowski)
@@ -43,3 +48,5 @@ The full documentation can be found [here](https://roach-php.dev).
4348
## License
4449

4550
MIT
51+
52+
[contribution-guide]: https://github.com/roach-php/core/blob/main/CONTRIBUTING.md

0 commit comments

Comments
 (0)
Please sign in to comment.