https://github.com/palashmon/github-templates
Some basic templates for your open-source project
https://github.com/palashmon/github-templates
github markdown template
Last synced: 4 months ago
JSON representation
Some basic templates for your open-source project
- Host: GitHub
- URL: https://github.com/palashmon/github-templates
- Owner: palashmon
- License: cc0-1.0
- Created: 2018-06-16T16:21:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-16T17:53:27.000Z (over 7 years ago)
- Last Synced: 2025-03-16T17:28:10.344Z (11 months ago)
- Topics: github, markdown, template
- Homepage:
- Size: 14.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README Template/README Template.md
- Contributing: CONTRIBUTING Template/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Your Project Name
One Paragraph of project description goes here
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
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
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
## Deployment
Add additional notes about how to deploy this on a live system
## Contributing
Your contributions are always welcome! Please read the [contribution guidelines](CONTRIBUTING.md) first.
## Changelog
A curated, chronologically ordered list of notable changes for each version of this project is documented in [this](CHANGELOG.md) file.
## Authors
- [**Palash Mondal**](https://github.com/palashmon) - _Initial work_
See also the list of [contributors](https://github.com/your/project/graphs/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc