A bunch of commit rules to be utilised with CommitLint at Weburz
npm install @weburz/commitlint-config!GitHub code size in bytes
!GitHub
!Twitter URL
About the project in not more than 5-10 sentences to keep the user engaged &
give them a brief idea of the project as well.
Share some usage guidelines here like:
1. How to download the project.
2. Once downloaded how to invoke the command & run it on the user's local
machine.
3. How & where to find help once the user starts using the project.
Share detailed guidelines on how the interested user can start contributing to
the project.
There are numerous ways to contribute to the project & here are a few ways I can
think of on the top of my head.
- Found bugs? Report it by opening an [issue thread][4].
- Have a better plugin or an enhancement suggestions? Let the author know about
it.
- Are you interested in writing Lua code or perhaps use this project as your
own? Then feel free to share a PR or two.
- Found the project useful to get started with working on Neovim ASAP? Then
consider sponsoring the author as it keeps him motivated & pays the bills.
To learn more about contributing to the project, refer to the "[Developer
Guidelines][13]" section of the wiki. Also don't forget to check out the more
detailed instructions as laid down in the "[Contributing Guidelines][14]" for
the project.
That said, if you've any questions related to the development of this project,
please feel to reach out to author & maintainer of the project!
The project is licensed under the terms & conditions (T&Cs) for the MIT license.
So, you free to use, distribute, copy, modify & such with the contents of this
repository in whatever manner you want to. The caveat is, your usage should
adhere to the T&Cs of the MIT license.
For more information on the licensing T&Cs, feel free to refer to the
LICENSE document.
[1]: https://www.example.com