Skip to content

Commit

Permalink
CONTRIBUTING.md: Adjust instructions with more detail
Browse files Browse the repository at this point in the history
  • Loading branch information
AfroThundr3007730 committed Mar 19, 2024
1 parent 28f3152 commit f68447e
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# How to Contribute

Note that I am not a code guru, I make plenty of mistakes. So if
you've found some - and would like to report them or submit a fix -
feel free to do so by [opening an issue][1] or pull request.
Feature additions or requests are also welcome here.
Note that the author is not a codeing expert, and makes plenty of mistakes. If
you've found one - and would like to report it or submit a fix - feel free to do
so by opening an [issue] or pull request. Feature additions or requests are also
welcome here.

For bug reports, feature requests, and questions, open as an issue,
and I will take a look.
For bug reports and feature requests, open an issue and provide any relevant
details there. Questions are not well suited to issue format, and may be better
addressed by asking instead on [Gitter].

For pull requests, features should be submitted to the `dev` branch,
while a bug fix gets pushed to `master` or the relevant release branch.
For pull requests, features and bug fixes should be submitted to the `dev`
branch. Bug fixes will also get pushed to `master` or the relevant release
branch when needed. Code submissions should be [lint] free, and follow best
practices where possible.

[1]: https://github.com/AfroThundr3007730/syncrepo/issues/new
[issue]: https://github.com/AfroThundr3007730/syncrepo/issues/new
[gitter]: https://matrix.to/#/#syncrepo:gitter.im
[lint]: https://github.com/koalaman/shellcheck

0 comments on commit f68447e

Please sign in to comment.