Skip to content

Commit f871d56

Browse files
committed
docs: update CONTRIBUTING.md and docs/manual/README.md
1 parent aac2441 commit f871d56

2 files changed

Lines changed: 14 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,29 @@
22

33
Contributions are welcome.
44

5+
6+
## Q&A
7+
8+
If you have questions relating to using the installed extension, see the [Q&A][] section on the Marketplace page.
9+
10+
511
## Issues
612

713
Create an issue under [Issues][] to request a feature, bug fix, or doc change.
814

915

1016
## Pull Requests
1117

12-
Create a Pull Request under [Pull Requests][]. Preferably with an issue first to discuss.
18+
Create a Pull Request under [Pull Requests][]. If you have questions or the change is complex, preferably make an issue first and discuss in then, then follow with a PR later.
1319

1420

1521
## Discussions
1622

17-
You can use the [Discussions][] section on GitHub too if you need help using the extension or understanding something.
23+
Use the [Discussions][] section on GitHub too if you need help working with the code.
24+
1825

1926

2027
[Issues]: https://github.com/MichaelCurrin/auto-commit-msg/issues
2128
[Pull Requests]: https://github.com/MichaelCurrin/auto-commit-msg/pulls
2229
[Discussions]: https://github.com/MichaelCurrin/auto-commit-msg/discussions
30+
[Q&A]: https://marketplace.visualstudio.com/items?itemName=MichaelCurrin.auto-commit-msg&ssr=false#qna

docs/manual/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
- How to run the extension. It will generate a Conventional Commit type prefix where possible and a description of file changes.
77
- [Conventional Commits](conventional-commits.md) info
88
- This doc explains more on this standard, which is used heavily in this extension.
9-
- [Q&A](https://marketplace.visualstudio.com/items?itemName=MichaelCurrin.auto-commit-msg&ssr=false#qna)
10-
- Ask questions on the Marketplace page.
9+
- [Q&A][]
10+
- Ask questions on the Marketplace page about how to use the installed extension or clarification on the [features](/docs/features.md) available.
1111
- [Uninstall](uninstall.md)
1212
- Remove the extension.
13+
14+
[Q&A]: https://marketplace.visualstudio.com/items?itemName=MichaelCurrin.auto-commit-msg&ssr=false#qna

0 commit comments

Comments
 (0)