- Please check the issues tab for things to work on.
- Please raise an issue to request a feature/modification or for reporting a bug, if it has not already been raised.
- Front end: Asciidoctor, HTML, CSS, JS
- CI/CD: GitHub Actions
-
Fork this repo. (Top right corner.)
-
Clone the forked repo using the
git clone
command. -
cd
into the cloned repo directory. -
Follow the Getting Started guide on the demo site and explore other sections to understand how the template is structured.
-
Write meaningful commit messages and include the number (#) of the issue being resolved (if any) at the end of the commit message.
Example:
:bug: fix: Resolve 'isCorrect' function error (#0)
-
Open a Pull Request (PR).
- Learn how to open a PR.
- Solve one issue per PR, without any extra changes.
- Include extra changes in a separate PR.
Make sure the following changes are made when releasing a new version
- Update the changelog with the appropriate version number and changes.
- Refer to the Keep a Changelog website for instructions.
- Update the version in the service worker. (On line number 1.)
- Update the version in the index.adoc file. (On line number 3.)
- Create an annotated tag (
git tag -a vx.x.x -m "Release vx.x.x"
) on the latest commit of that release.
If any further help is needed, do not hesitate to contact the author (Harsh Kapadia) via Twitter @harshgkapadia, LinkedIn or e-mail ([email protected]). An issue can be raised as well.