mirror of
https://github.com/kiwix/kiwix-android.git
synced 2025-08-03 02:36:24 -04:00
Updated badges and documentation.
* Fixed the badging of `Build Status` and `Codecov`. * Since there is no `master` and `develop` branches, we have updated our `CONTRIBUTING.md` to reflect these changes.
This commit is contained in:
parent
bd27edc649
commit
4da3922a18
@ -32,7 +32,7 @@ Our process for accepting changes operates by [Pull Request (PR)](https://help.g
|
||||
|
||||
1. **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
|
||||
https://github.com/kiwix/<repository-name>/pull/new/main
|
||||
|
||||
1. 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`)
|
||||
|
||||
@ -44,10 +44,9 @@ Our process for accepting changes operates by [Pull Request (PR)](https://help.g
|
||||
|
||||
Our branching strategy is based on [this article](https://nvie.com/posts/a-successful-git-branching-model/) 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
|
||||
+ **main** 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/\<username\>/ 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.
|
||||
Typically a feature branch is off of main and into develop but in rare scenarios if there is an issue in production a branch may be made off main to fix this issue, this type of feature branch must be merged to main before being deleted.
|
||||
Branch names should be in the format **\<issue-number\>-kebab-case-title**
|
||||
|
||||
All branches should have distinct history and should be visually easy to follow, for this reason only perform merge commits when merging code either by PR or when synchronising.
|
||||
|
@ -39,9 +39,9 @@ website to access the complete set of features.
|
||||
|
||||
Kiwix Android is written in [Kotlin](https://kotlinlang.org/)
|
||||
|
||||
[](https://github.com/kiwix/kiwix-android/actions?query=workflow%3ACI+branch%3Amain)
|
||||
[](https://github.com/kiwix/kiwix-android/actions?query=workflow%3ACI+branch%3Amain)
|
||||
[](https://github.com/kiwix/kiwix-android/actions/workflows/nightly.yml)
|
||||
[](https://codecov.io/gh/kiwix/kiwix-android)
|
||||
[](https://codecov.io/gh/kiwix/kiwix-android)
|
||||
[](https://www.codefactor.io/repository/github/kiwix/kiwix-android)
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
[](https://chat.kiwix.org)
|
||||
|
Loading…
x
Reference in New Issue
Block a user