Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 3.29 KB

Contributing to Flutter ZoomSwiper

First off, thank you for considering contributing to Flutter ZoomSwiper! It's people like you that make Flutter ZoomSwiper such a great project.

Code of Conduct

This project and everyone participating in it is governed by the Flutter ZoomSwiper Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

Before creating enhancement suggestions, please check the issue list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Pull Requests

The process described here has several goals:

  • Maintain Flutter ZoomSwiper's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Flutter ZoomSwiper
  • Enable a sustainable system for Flutter ZoomSwiper's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing
  4. If applicable, make sure that any associated issues have been closed

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies

Dart Styleguide

All Dart code must adhere to the Dart Style Guide.

  • Use dartfmt to format your code.
  • Use dartanalyzer to check your code for errors and warnings.
  • Follow the Effective Dart guidelines for writing idiomatic and efficient Dart code.

Documentation Styleguide

  • Use Markdown.
  • Reference images by their filename in uppercase, without file extension (e.g., [IMAGE_NAME]).
  • Reference other files by their filename in uppercase (e.g., [FILE_NAME]).