📰 writeme

Cross-platform README generator for your project

Table of Contents

• Table of Contents
• 🏁 Getting Started
  • ⚙️ Configuration
  • ⬇️ Installation
  • 🎈 Usage
• 📄 License
• 🔭 Contributing
  • 🐛 Issues
  • 🤝 Pull Requests
  • 🎨 Style Guide
  • Commits rules
    • Type
    • Scope
    • Subject
• ✍️ Authors
• 🎉 Acknowledgements

  🏁 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.

⚙️ Configuration

bash software and dependencies to install before running the project futher instructions...

⬇️ Installation

bash git clone https://github.com/BabelDev0/writeme futher instructions...

🎈 Usage

bash command to run the project futher instructions...

📄 License

MIT OR Apache-2.0

🔭 Contributing

🎉 Thank you for being interested in contributing to project! 🎉

Feel welcome and read the following sections in order to know how to ask questions and how to work on something.

Please make sure you are welcoming and friendly in all of our spaces. 👍

🐛 Issues

The best way to contribute to our projects is by opening a new issue or tackling one of the issues that are already open.

🤝 Pull Requests

Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide: 1. Fork the repo. documentation changes require no new tests. 1. Make sure to check out the Style Guide and ensure that your code complies with the rules. 2. Commit your changes. 3. Push to your fork and submit a pull request. Please provide us with some explanation of why you made the changes you made.

🎨 Style Guide

Commits rules

For commits it is recommended to use Conventional Commits.

Type

The type must be one of the following:

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
• perf: A code change that improves the performance
• test: Adding missing or correcting existing tests
• build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
• ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
• chore: Other changes that don't modify src or test files
• revert: Reverts a previous commit

Scope

The scope should be the name of the piece of the project affected.

Subject

The subject contains a succinct description of the change:

• Use the imperative, present tense: "change" not "changed" nor "changes"
• Don't capitalize the first letter
• No dot (.) at the end

✍️ Authors

• BabelDev0
• Luca Corsetti

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References