User Tools

Site Tools


contributing_mappings

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision Both sides next revision
contributing_mappings [2019/08/12 22:11]
be.ing [Documenting the mapping]
contributing_mappings [2020/01/20 18:16]
hlzhs
Line 14: Line 14:
 We use Git for coordinating Mixxx development. Git is software that helps keep track of changes in files. Before you start working on your mapping, it is recommended (but not necessary) to set up git on your computer. Using git will help you keep track of your progress on the mapping and help Mixxx developers review it. If you have already finished your mapping, that's okay, just add your finished mapping files in one commit. Start by creating a [[http://​github.com/​|GitHub]] account, [[https://​github.com/​mixxxdj/​mixxx|forking Mixxx]], and cloning your forked git repository onto your computer. We use Git for coordinating Mixxx development. Git is software that helps keep track of changes in files. Before you start working on your mapping, it is recommended (but not necessary) to set up git on your computer. Using git will help you keep track of your progress on the mapping and help Mixxx developers review it. If you have already finished your mapping, that's okay, just add your finished mapping files in one commit. Start by creating a [[http://​github.com/​|GitHub]] account, [[https://​github.com/​mixxxdj/​mixxx|forking Mixxx]], and cloning your forked git repository onto your computer.
  
-Make a new git branch (run ''​git checkout -b new_branch_name''​ from within your git repository). Make changes to your mapping and commit them when your changes work. Before making any commits, configure git to use your name and email in your commits. See the [[Using Git]] wiki page for more information. Please prefix your git commit messages with the name of your controller so others can easily tell what the commits are for after your changes are merged. For example, a good commit message could look like:\\+Usually, ​new mappings can be released as part of bugfix releases. Hence, you should usually use the current stable release ​branch (e.g. `2.2`) instead of the `master` branch as a starting point for your new mapping branch. You run ''​git checkout -b new_branch_name ​2.2''​ from within your git repository ​to that. If you're making use of unreleased features that are only present in `master`, you can also use `master` as base branch instead (run ''​git checkout -b new_branch_name master''​). 
 + 
 +Make changes to your mapping and commit them when your changes work. Before making any commits, configure git to use your name and email in your commits. See the [[Using Git]] wiki page for more information. Please prefix your git commit messages with the name of your controller so others can easily tell what the commits are for after your changes are merged. For example, a good commit message could look like:\\
 ''​Hercules P32: push browse encoder to maximize/​minimize library''​ ''​Hercules P32: push browse encoder to maximize/​minimize library''​
  
Line 26: Line 28:
 ==== Submitting your mapping for review ==== ==== Submitting your mapping for review ====
  
-When your mapping is complete, [[#​Documenting the mapping|documented on the wiki]], and you are ready to submit your mapping for inclusion in Mixxx, make a pull request on GitHub. Make sure that the target branch of mixxxdj/​mixxx for your pull request is the branch that you started your git branch from (if it isn't, you'll see commits unrelated to your mapping included in your pull request).+When your mapping is complete, [[#​Documenting the mapping|documented on the wiki]], and you are ready to submit your mapping for inclusion in Mixxx, make a pull request on GitHub. Make sure that the target branch of mixxxdj/​mixxx for your pull request is the branch that you started your git branch from (if it isn't, you'll see commits unrelated to your mapping included in your pull request). If you accidently started from the wrong branch when working on your mapping, you can also  [[https://​mixxx.org/​wiki/​doku.php/​using_git#​targeting_another_base_branch|rebase and change the target of your PR]].
  
 Although we try not to let pull requests linger without review, keep in mind that Mixxx is a volunteer project and someone will review your pull request when they have time available. Mappings will be reviewed to check that they follow the [[#design guidelines]],​ [[#coding conventions for JavaScript]],​ [[#coding conventions for XML]], to check that the mapping is [[#​documenting the mapping|documented well on the wiki]], and to look for potential bugs. To update your mapping in response to reviewers'​ comments, edit your file(s), make a new git commit, and push your git commit. The new commit(s) will automatically show up in the pull request. Although we try not to let pull requests linger without review, keep in mind that Mixxx is a volunteer project and someone will review your pull request when they have time available. Mappings will be reviewed to check that they follow the [[#design guidelines]],​ [[#coding conventions for JavaScript]],​ [[#coding conventions for XML]], to check that the mapping is [[#​documenting the mapping|documented well on the wiki]], and to look for potential bugs. To update your mapping in response to reviewers'​ comments, edit your file(s), make a new git commit, and push your git commit. The new commit(s) will automatically show up in the pull request.
contributing_mappings.txt · Last modified: 2020/03/24 07:55 by hlzhs