Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 1.8 KB

File metadata and controls

19 lines (13 loc) · 1.8 KB

Contributor's Guide

Here are a couple of things to make your experience in the community more enjoyable.

Before you start coding: The Design Phase

The code of Yafc is complicated enough that we want to make it simpler. In other words, if your feature increases the complexity, then please make a github issue with your proposal before coding, so we can discuss if this feature can be added to Yafc.

Setting up environment

  • Please inspect and run set-up-git-hooks.sh once. It sets up a formatting check to be run before git push, to make sure that the basic formatting is fine.

Coding

  • For the conventions that we use, please refer to the Code Style.
  • In Visual Studio, you can check some of the rules by running Code Cleanup, or Format Document with "Ctrl+K, Ctrl+D".

Pull Request

  • In the changelog, please provide a short description of your change.
  • In the PR, please provide a short description of the issue, and how your PR solves that issue.
  • It would be appreciated if you reorganize your commits before the merge -- separate and squash them into logical steps, so they are easier to review and understand. For instance, the fixes to the commits can be squashed into them. The reordering of the commits can be done with the interactive rebase: git rebase -i head~n, but please read beforehand on how to do it, so you don't accidentally delete your efforts. If you want to go godlike, feel free to read on git commit --fixup= and git rebase -i --autosquash (example). However, it can be the case that the reordering requires very tricky merges, so it's okay to leave the commits as-is in this case.