Contributing to the WissKI Codebase
Before you create a new issue, please check the WissKI issue tracker first, as your problem may already exist or even be solved. If you cannot find an appropriate issue there please follow the workflow described below.
Issue Workflow¶
We generally follow the Drupal issue workflow for feature requests and bug reports.
Creating an Issue¶
Create new issues with Drupal issue tracker
Fill the mandatory fields like Title, Project, Category, Priority, Status, Version, Component, Assigned. Remember to choose the correct development version, i.e. 8.x-4.x.
Provide some tags and speaking summary.
Click Save.
Create an Issue Fork¶
In case you wish to contribute to the WissKI codebase you have to create an issue fork. When on the the issue page, click Create issue fork. You may want to choose a custom fork name.
Usually the commands needed to set up the repository as a remote are shown in the issue interface when clicking Show commands.
Add & fetch this issue fork’s repository to your existing WissKI git.
git remote add <fork name> git@git.drupal.org:issue/<fork name>.git
git fetch <fork name>
Example:
git remote add wisski-3544557 git@git.drupal.org:issue/wisski-3544557.git
git fetch wisski-3544557
In this case the provided fork name is wisski-3544557.
Create new branch in fork by clicking Create new branch.
Choose a fork branch name, in this case we chose 3544557-update-docs for the \<fork branch name>.
Switch to the fork branch.
git checkout -b <fork branch name> --track <fork name>/<fork branch name>
Example:
git checkout -b '3544557-update-docs' --track wisski-3544557/'3544557-update-docs'
Apply your changes, commit and push back to the fork repository.
git add <files that changed>
git commit -m "<your commit message>"
git push <fork branch name>
After you are done with your changes you can create a merge request to submit your changes for review.