Skip to content

nathaliabruno/github-project-boilerplate

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Short description (one line) about what this project stands for.

Under Development Public Domain

Short project's overview (one paragraph) explaining what this project stands for. Using this boilerplate, three lines is a good length for briefly explaining this project's purpose while respecting the base layout. πŸ‘½



Installing

So, how users can get this project up and running on their machines?

Describe it in a nice way. Code sample with installation basics **works great**

Getting Started

What does this project stands for?

Usage

Tell contributors how to use it.

Contributing

Write some Contributing guidelines or a Contributors list (or both!). Like:

Please read CONTRIBUTING.md for more details.

or if you like it simple

  1. Fork this repository
  2. Create a branch
  3. Commit your changes
  4. Push your commits to the branch
  5. Submit a pull request

More here

Check also the list of contributors who helped on this project.

Changelog πŸ“

Write here a link for your CHANGELOG file. It's also commonly called HISTORY.

As said on this project main README file, to keep you and your project sane, you can use this tool.

Acknowledgments πŸ‘

Reference someone's code you used, insert an external link or thank people, i.e.:

  • Shields.io. Definitely a must-have.
  • Travis-CI. Another must-have. Test and Deploy with Confidence.

To-Do πŸ‘¨

If your project is still in an early release, a to-do list is a good thing to keep track:

  • Include something
  • Another something
  • So on...

License

Include a refence for the license you choosed. For this project my take was the Public License:

CC0

Cezar Augusto has dedicated the work to the public domain by waiving all of his rights to the work worldwide under copyright law. More about CC licenses here.

About

:octocat: πŸ“‹ Collection of template files for authoring a GitHub project.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published