kiwix/kiwix-android
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-android.git synced 2025-08-03 10:46:53 -04:00
Code Issues Packages Projects Releases Wiki Activity
kiwix-android/CONTRIBUTING.md
Sean Mac Gillicuddy c6491281e2 #1200 remove hotfix line, expnd feature line
2019-06-24 16:00:53 +01:00

3.9 KiB
Raw Blame History

Contributing Guidelines

We love improvements to our tools! There are a few key ways you can help us improve our projects:

Submitting Feedback, Requests, and Bugs

Our process for submitting feedback, feature requests, and reporting bugs usually begins by discussion on our chat and, after initial clarification, through GitHub issues. Each project repository generally maintains its own set of issues:

    https://github.com/kiwix/<repository-name>/issues

Some projects have additional templates or sets of questions for each issue, which you will be prompted to fill out when creating one.

Issues that span multiple projects or are about coordinating how we work overall are in the Overview Issue Tracker.

Submitting Code and Documentation Changes

We still do not have project guidelines for all of the projects hosted in our GitHub Organization, which new repositories should follow during their creation.

Our process for accepting changes operates by Pull Request (PR) and has a few steps:

  1. If you haven't submitted anything before, and you aren't (yet!) a member of our organization, fork and clone the repo:

    $ git clone git@github.com:<your-username>/<repository-name>.git

    Organization members should clone the upstream repo, instead of working from a personal fork:

    $ git clone git@github.com:kiwix/<repository-name>.git

  2. Create a new branch for the changes you want to work on. Choose a topic for your branch name that reflects the change:

    $ git checkout -b <branch-name>

  3. Create or modify the files with your changes. If you want to show other people work that isn't ready to merge in, commit your changes then create a pull request (PR) with WIP or Work In Progress in the title.

    https://github.com/kiwix/<repository-name>/pull/new/master

  4. Once your changes are ready for final review, commit your changes then modify or create your pull request (PR), assign as a reviewer or ping (using "@<username>") a Lieutenant (someone able to merge in PRs) active on the project (all Lieutenants can be pinged via @kiwix/lieutenants)

  5. Allow others sufficient time for review and comments before merging. We make use of GitHub's review feature to comment in-line on PRs when possible. There may be some fixes or adjustments you'll have to make based on feedback.

  6. Once you have integrated comments, or waited for feedback, a Lieutenant should merge your changes in!

Branching

Our branching strategy is based on this article which we suggest you read.

  • master a history of releases, once merged to from develop and tagged we create a release on the play store & GitHub releases.
  • develop the actively worked on next release of the app, what we branch off of while working on new features and what we merge into upon feature completion
  • feature/ or feature// any branch under this directory is an actively developed feature, feature branches culminate in a PR, are merged and deleted. Typically a feature branch is off of develop and into develop but in rare scenarios if there is an issue in production a branch may be made off master to fix this issue, this type of feature branch must be merged to develop and master before being deleted.

All branches should have distinct history and should be visually easy to follow, for this reason only preform merge commits when merging code either by PR or when synchronising.

Rebasing should be avoided.

These guidelines are based on Tools for Government Data Archiving's.