Skip to content

Latest commit

 

History

History
241 lines (165 loc) · 9.38 KB

CONTRIBUTING.md

File metadata and controls

241 lines (165 loc) · 9.38 KB
Raw

Contribution Guidelines

Note: If these contribution guidelines are not followed your issue or PR might be closed, so please read these instructions carefully.

Contribution types

Bug Reports

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

Bug Fix

  • If you'd like to submit a fix for a bug, please read the How To for how to send a Pull Request.
  • Indicate on the open issue that you are working on fixing the bug and the issue will be assigned to you.
  • Write Fixes #xxxx in your PR text, where xxxx is the issue number (if there is one).
  • Include a test that isolates the bug and verifies that it was fixed.

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 issue.
    • You can also join us on Discord to discuss some initials thoughts.
  • 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 future development direction.
  • Implement the code for the new feature and please read the How To.

Documentation & Miscellaneous

  • If you have suggestions for improvements to the documentation, tutorial or examples (or something else), we would love to hear about it.
  • As always first file a Github issue.
  • Implement the changes to the documentation, please read the How To.

How To Contribute

Requirements

For a contribution to be accepted:

  • Follow the Style Guide when writing the code;
  • Format the code using dart format .;
  • Lint the code with melos run analyze;
  • Check that all tests pass: melos run test;
  • Documentation should always be updated or added (if applicable);
  • Examples should always be updated or added (if applicable);
  • Tests should always be updated or added (if applicable) -- check the Test writing guide for more details;
  • The PR title should start with a conventional commit prefix (feat:, fix: etc).

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

Open an issue and fork the repository

  • If it is a bigger change or a new feature, first of all file a bug or feature report, so that we can discuss what direction to follow.
  • Fork the project on GitHub.
  • Clone the forked repository to your local development machine (e.g. git clone git@github.com:<YOUR_GITHUB_USER>/flame.git).

Environment Setup

Flame is setup to run with the most recent stable version of Flutter, so make sure your version matches that:

flutter channel stable

Also, Flame uses Melos to manage the project and dependencies.

To install Melos, run the following command from your terminal:

flutter pub global activate melos

Next, at the root of your locally cloned repository bootstrap the projects dependencies:

melos bootstrap

The bootstrap command locally links all dependencies within the project without having to provide manual dependency_overrides. This allows all plugins, examples and tests to build from the local clone project. You should only need to run this command once.

You do not need to run flutter pub get once bootstrap has been completed.

CSpell

If you want to run the spellchecker locally, you will have to install cspell; you can do so using npm or yarn:

npm install -g cspell

Then you can run it with the following arguments:

cspell --no-progress -c .github/cspell.json "**/*.{md,dart}"

Markdown Lint

If you want to lint the markdown files you have to install markdownlint-cli and once that is installed you can run melos markdown-check to check if the markdown follows the rules. Some markdown linting errors can be automatically fixed with melos markdown-fix.

Note that, sadly, a particularly laborious rule, MD013, does not provide an auto-fix option. However, you can use other tools to circumvent this. For example, the extension Rewrap for VSCode, when configured with rewrap.wrappingColumn=100, will do the trick for you.

Performing changes

  • Create a new local branch from main (e.g. git checkout -b my-new-feature)
  • Make your changes (try to split them up with one PR per feature/fix).
  • When committing your changes, make sure that each commit message is clear (e.g. git commit -m 'Take in an optional Camera as a parameter to FlameGame').
  • Push your new branch to your own fork into the same remote branch (e.g. git push origin my-username.my-new-feature, replace origin if you use another remote.)

Breaking changes

When doing breaking changes a deprecation tag should be added when possible and contain a message that conveys to the user what which version that the deprecated method/field will be removed in and what method they should use instead to perform the task. The version specified should be at least two versions after the current one, such that there will be at least one stable release where the users get to see the deprecation warning and in the version after that (or a later version) the deprecated entity should be removed.

Example (if the current version is v1.3.0):

@Deprecated('Will be removed in v1.5.0, use nonDeprecatedFeature() instead')
void deprecatedFeature() {}

Open a pull request

Go to the pull request page of Flame and in the top of the page it will ask you if you want to open a pull request from your newly created branch.

The title of the pull request should start with a conventional commit type.

Allowed types are:

  • fix: -- patches a bug and is not a new feature;
  • feat: -- introduces a new feature;
  • docs: -- updates or adds documentation or examples;
  • test: -- updates or adds tests;
  • refactor: -- refactors code but doesn't introduce any changes or additions to the public API;
  • perf: -- code change that improves performance;
  • build: -- code change that affects the build system or external dependencies;
  • ci: -- changes to the CI configuration files and scripts;
  • chore: -- other changes that don't modify source or test files;
  • revert: -- reverts a previous commit.

If you introduce a breaking change the conventional commit type MUST end with an exclamation mark (e.g. feat!: Remove the position argument from PositionComponent).

Examples of PR titles:

  • feat: Component.childrenFactory can be used to set up a global ComponentSet factory
  • fix: Avoid infinite loop in FlameGame
  • docs: Add a JoystickComponent example
  • docs: Improve the Mandarin README
  • test: Add infinity test for MoveEffect.to
  • refactor: Optimize the structure of the game loop

Maintainers

These instructions are for the maintainers of Flame.

Merging a pull request

When merging a pull request, make sure that the title of the merge commit has the correct conventional commit tag and a descriptive title. This is extra important since sometimes the title of the PR doesn't reflect what GitHub defaults to for the merge commit title (if the title has been changed during the life time of the PR for example).

All the default text should be removed from the commit message and the PR description and the instructions from the "Migration instruction" (if the PR is breaking) should be copied into the commit message.

Creating a release

There are a few things to think about when doing a release:

  • Search through the codebase for @Deprecated methods/fields and remove the ones that are marked for removal in the version that you are intending to release.
  • Create a PR containing the changes for removing the deprecated entities.
  • Run melos version -V <package1>:<version> -V <package2>:<version> for Melos to generate CHANGELOG.md files.
  • Go through the PRs with breaking changes and add migration documentation to the changelog. There should be migration docs on each PR, if they haven't been copied to the commit message.
  • Run melos publish to make sure that there aren't any problems with any of the packages and make sure that all the versions are correct.
  • Once you are satisfied with the result of the dry run, run melos publish --no-dry-run
  • Create a PR containing the updated changelog and pubspec.yaml files.