Project Title
This is a git repo template.
Getting Started
This is a git repo template
Prerequisites
Requirements for the software and other tools to build, test and push
Installing
A step by step series of examples that tell you how to get a development environment running
Copy the whole file and its contents to the new repository directory you are creating.
cp -r git-repo-template repository-directory
Go to the new directory.
cd repository-directory
Make the Git hooks executable.
chmod +x .githooks/commit-msg .githooks/post-commit
Initialise the Git repository.
git init
Configure repository to use .githooks directory for all hooks.
git config core.hooksPath .githooks
End with an example of getting some data out of the system or using it for a little demo
Running the tests
Explain how to run the automated tests for this system
Sample Tests
Explain what these tests test and why
Give an example
Style test
Checks if the best practices and the right coding style has been used.
Give an example
Deployment
Add additional notes to deploy this on a live system
Built With
- Contributor Covenant - Used for the Code of Conduct
- Creative Commons - Used to choose the license
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
Authors
- Eric Cebolenkosi Chiruka
- Billie Thompson - Provided README Template
See also the list of contributors who participated in this project.
License
This project is licensed under the [CC0 1.0 Universal](LICENSE.md) Creative Commons License - see the [LICENSE.md](LICENSE.md) file for details
Acknowledgments
- Hat tip to anyone whose code is used
- Inspiration
- etc
Personal projects
View all- Loading