Skip to content

For Developers: Making Patches

Jason Gerecke edited this page Apr 4, 2022 · 9 revisions

If you have part participated in a Github project previously, please first read through Github's "Contributing to projects" documentation. It provides an excellent introduction to the steps that you will need to take to get set up for making changes.

Beyond these basics, we also recommend following practices when working with git:

  • Add an 'upstream' remote to the clone of your fork: git remote add https://github.com/linuxwacom/xf86-input-wacom.git
  • Always ensure you start new work on an up-to-date branch off of our upstream: git remote update && git checkout upstream/master -b my-new-branch-name

Finally, please be aware of the following project-specific suggestions for making new patches:

  • Please update the automated tests any time you write a new feature or fix a bug
  • Please test your changes on a wide range of devices (especially both display and opaque) and ensure the automated tests continue to pass
  • Be sure to respect our our commit message requirements
  • If your work makes extensive changes or can be broken into several independent pieces, you should consider creating multiple small commits instead of one large one. This makes it much easier for us to understand and review the patches.

Follow the instructions at "For Developers: Submitting Patches" for any final tips on the actual submission process.

Clone this wiki locally