README_mume.md

markdown
image_dir ignore_from_front_matter absolute_image_path docs true false

Decorator

🚀 About

Python's decorators in dart 🎆

Note: This is a work-in-progress

📄 TOC

1. 🚀 About
2. 📄 TOC
3. 📖 Usage
   1. 1. Decorator annotation
   2. 2. Decorator generator
4. 🚥 Versioning
5. 📝 Milestones
6. 🏅 Principle
7. 👥 Contributing
8. Git
9. 💄 Code style
10. ✅ Testing
11. ✨ Features and 🐛bugs
12. 📰 Changelog
    1. 1. Decorator annotation
       1. 0.0.1
    2. 2. Decorator generator
       1. 0.0.1
13. 📜 License

📖 Usage

1. Decorator annotation

@import "decorator/README_mume.md"

2. Decorator generator

@import "decorator_generator/README_mume.md"

🚥 Versioning

This project follows Semantic Versioning 2.0.0

📝 Milestones

• Prepare v1.0.0
  • allow decorating class methods
  • allow decorating class fields
  • allow decorating top-level methods
  • allow decorating top-level fields
  • allow decorating classes
  • allow decorating libraries

🏅 Principle

This project follows The Twelve-Factor App principle

👥 Contributing

• 🍴 Fork this repo

• ⬇️ Clone your forked version
  git clone https://github.com/<you>/decorator.git

• ➕ Add this repo as a remote
  git remote add upstream https://github.com/devkabiir/decorator.git

• ⏬ Make sure you have recent changes
  git fetch upstream

• ✨ Make a new branch with your proposed changes/fixes/additions
  git checkout upstream/master -b name_of_your_branch

• 📑 Make sure you follow guidelines for Git

• ⏫ Push your changes
  git push origin name_of_your_branch

• 🔃 Make a pull request

Git

• ✔️ Sign all commits. Learn about signing-commits
• Use commitizen with cz-emoji adapter
• Check existing commits to get an idea
• Run the pre_commit script from project root pub run pre_commit
• If you're adding an and in your commit message, it should probably be separate commits
• Link relevant issues/commits with a # sign in the commit message
• Limit message length per line to 72 characters (excluding space required for linking issues/commits)
• Add commit description if message isn't enough for explaining changes

💄 Code style

• Maintain consistencies using included .editorconfig
• Everything else as per standard dart guidelines

✅ Testing

• Add tests for each new addition/feature
• Do not remove/change tests when refactoring
  • unless fixing already broken test.

✨ Features and 🐛bugs

Please file feature requests and bugs at the issue-tracker.

📰 Changelog

Changes for latest release at github-releases

@import "CHANGELOG_mume.md"

📜 License

@import "LICENSE"