Skip to content

Flutterando's Readme template for the community packages and projects (based on othneildrew/Best-readme-template)

License

Notifications You must be signed in to change notification settings

Flutterando/flutterando-readme-template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Best-README-Template - Flutterando Version


Logo Logo

A Flutterando style README template for the community's projects and packages. It is open and free to use in your projects too!

View Example · Report Bug · Request Feature



Table of Contents
  1. About The Project
  2. Contributing
  3. License
  4. Contact
  5. Acknowledgments


📝 About The Project

From the many great README templates available on GitHub we chose Othneildrew's template as a base for the Readme used on the Flutterando community projects, because of it's layout and it being easy to implement. We modified it to be more in tune with the packages and projects of our community and to have a go-to readme when we start something new.

Othneildrews's said this in his project, and we feel it apllies for us too when it comes to writing your Readme for a project:

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others
  • You shouldn't be doing the same tasks over and over like creating a README from scratch
  • You should implement DRY principles to the rest of your life 😊

Of course, one template will never fit all projects, but we hope that this one can be of help to yours as it was to the Flutterando community packages. We also, as always, accept suggestions, send yours by forking this repo and creating a pull request of it.


This project is distributed under the MIT License. See LICENSE.txt for more information.


✨ Usage

Use the BLANK_README.md to get started. Copy it, modify it for your project and use the EXAMPLE_README.md to also guide you.

(back to top)

🧑‍💻 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Just create a pull request with your suggestions and changes or be in contact with us through Discord or any other of the links below.

In addition to writing code, there are many ways for you to contribue.

You can contribute as following:

You can read this repository’s Contributing Guidelines to learn how to contribute.

Here's a quick guide to help you contribute to Flutterando.

Development environment

Learn how to set up your local environment, go to our Developer Guide.

Git workflow basic

Here's a general APITable git workflow:

  1. Create an issue and describe features you want -> flutterando-readme-template issues
  2. Fork this project -> Fork flutterando-readme project
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some features')
  5. Publish the branch (git push origin my-new-feature)
  6. Create a new Pull Request -> Create pull request across forks

Work conventions

APITable use these common conventions:

(back to top)


💬 Contact

Flutterando Community

(back to top)


👥 Contributors

(back to top)

🛠️ Maintaned by


This fork version is maintained by Flutterando.

About

Flutterando's Readme template for the community packages and projects (based on othneildrew/Best-readme-template)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published