Skip to content

Creating a Pull Request

Miguel Ruivo edited this page Mar 29, 2020 · 1 revision

Likewise the branch rules naming convections, we recommend you to always to create a pull request that follows some procedures.

Those are listed below in order:

  1. Run flutter format . in your project root folder, just to make sure all files that you have edited follow the Dart formatter 80 line length guideline — however, do not commit files that you didn't added changes, despite being formatted with this;

  2. Do not check into source control files that shouldn't be added (although .gitignore protects you from this);

  3. Create your commit with a description of what has been done and, preferably, with a reference to the issue ID, for example, a possible commit message could be: FIX - Fix API call (#100) and you can also add a commit description whenever needed;

  4. When creating the PR, add a small description (that can be automatically taken from the issue description telling what has been done and do not forget to add a reference do closing issue that that PR closes, when applicable (eg. Closes #100). This will automatically close that issue whenever the PR is merged;

  5. Always make sure that you are creating a PR to dev branch;

Clone this wiki locally