Skip to content

Latest commit

 

History

History
78 lines (68 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

78 lines (68 loc) · 4.09 KB
Raw

Contributing Guidelines

If you're interested in contributing to this project, here are a few ways to do so:

Note: If these contributing guidelines are not followed we will close the issue or PR, please read these instructions carefully.

Bug fixes

  • If you find a bug, please first report it using Github issues.
    • First check if there is not already an issue for it; duplicated issues will be closed.
  • Issues that have already been identified as a bug will be labelled "bug".
  • If you'd like to submit a fix for a bug, send a Pull Request from your own fork, also read the How To and Development Guidelines.
  • Include a test that isolates the bug and verifies that it was fixed.
  • Also update the examples and documentation if necessary.

New Features

  • If you'd like to add a feature to the library that doesn't already exist, feel free to describe the feature in a new Github issues.
    • You can also join us on Discord to discuss some initials thoughts.
  • Issues that have been identified as a feature request will be labelled "enchanment".
  • If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, enhancements may not align well with the project objectives at the time.
  • Implement your code and please read the How To and Development Guidelines.
  • Also update the examples and documentation where needed.

Documentation & Miscellaneous

  • If you think the documentation could be clearer or an example should be added, or you have an alternative implementation of something that may have more advantages, we would love to hear it.
  • As always first file a report in Github issues.
  • Issues that have been identified as a documentation change will be labelled "documentation".
  • Implement the changes to the documentation, please read the How To and Development Guidelines.

Requirements

For a contribution to be accepted:

If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the issue. You can still continue to add more commits to the branch you have sent the Pull Request from.

How To Contribute

  • First of all file an bug or feature report on this repository.
  • Fork the project on Github
  • Clone the forked repository to your local development machine (e.g. git clone https://github.com/<YOUR_GITHUB_USER>/flame.git)
  • Run flutter pub get in the cloned repository to get all the dependencies
  • Create a new local branch based on issue number from first step (e.g. git checkout -b 12-new-feature)
  • Make your changes
  • When committing your changes, make sure to start the commit message with #<issue-number> (e.g. git commit -m '#12 - New Feature added')
  • Push your new branch to your own fork into the same remote branch (e.g. git push origin 12-new-feature)
  • On Github goto the pull request page on your own fork and create a merge request to this repository

Development Guidelines

  • Documentation should be updated.
  • Examples should be updated.
  • Format the Dart code accordingly.
  • Note the analysis_options.yaml and write code as stated in this file

Test generating of dartdoc

  • Run the ./scripts/dartdoc.sh script to generate the Dart documentation.
  • Output will be placed into doc/api/.