Skip to content

Contribute Changes Workflow

Georg Link edited this page Jan 17, 2016 · 1 revision

This workflow describes how anyone can contribute changes to Docear. If you have ideas for how to improve the workflow, please discuss it on the developer mailing list.

Step 1: Issue based solution

Before developing a solution, first find the related issue or create one.

An issue describes a bug or feature and channels discussions. All development should be related to issues to allow the discussions. Assign yourself to an issue if you plan to work on it.

Step 2: Develop in a fork

Develop and test solutions to an issue in a fork (can be a personal fork).

Reference issues in commit messages and help close issues via commit messages.

Make sure to document code. It helps others understand the logic.

Step 3: Pull-request changes

To get changes into the master branch of Docear, create a pull-request with changes.

Pull-requests are a great way to engage docear developers in a discussion and request feedback. Feel free to create a pull request with as little as an idea and initial implementation. If someone suggests a change before accepting a pull-request, that is a good sign.