Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (44 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 1.74 KB

Contributing to Flutter Graph View

Thank you for your interest in contributing to Flutter Graph View! This document provides guidelines and instructions for participating in this project.

Code of Conduct

When participating in this project, please respect and be considerate of others. We welcome contributions from everyone.

How to Contribute

1. Reporting Issues

  • Use the GitHub issue tracker to report bugs or request features
  • Check if an issue already exists before creating a new one
  • Provide a clear title and description
  • Include reproduction steps (for bugs)
  • Add Flutter version, device information, and relevant code snippets

2. Development Process

2.1 Fork from the project homepage

2.2 Set up the development environment

# Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/flutter_graph_view.git
cd flutter_graph_view

# Install dependencies
flutter pub get

# Run the example
cd example
flutter create .
flutter run

2.3 Add your creativity

  • New feature development, bug fixes, documentation updates...
  • If possible, demonstrate the changes in the example.

2.4 Let CHANGELOG.md hear your voice.

2.5 Leave your mark

  • All contributors are welcome, not limited to PRs, add your mark in the AUTHORS file.

2.6 Commit checks

  • Run dart format .
  • Commit
    • Commit messages should preferably have prefixes such as:
      • feat
      • fix
      • doc
      • refac
      • chore
      • ...

2.7 If these restrictions dampen your enthusiasm, feel free to ignore them. Compared to great creativity, rules are insignificant.

3. Special Notes

The current repository follows the permissive Apache License 2.0.