Skip to content

Latest commit

 

History

History
94 lines (58 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

94 lines (58 loc) · 3 KB
Raw

Contributing to the project!

Hey! We are delighted to see your interest in helping and contributing us on TweaksKM app.

Let's get started with setting up the development enviornment for work and app to run. Please read all the steps below carefully.

Setting up enviroment

Step 1: Setting up Git

First you need to install Git. after that you need to fork our repository located at https://github.com/theradcolor/TweaksKM.

After forking the repository, clone the forked repo to the system using

git clone https://github.com/<YOUR_GITHUB_USERNAME>/TweaksKM.git

Change directory to the newly downloaded forked copy.

cd TweaksKM

Step 2: Configuring Android Studio and SDKs

  • Download Android Studio and SDKs.
  • Change directory to ~/android-studio/bin/ and run studio bash (For Unix/Linux bases system).
  • Further docs and instructions can be found on Androids developer site.

Step 3: Git Branching

We should always work in branches to keep the master undisturbed and enforce a good collaboration enviornment.

Before creating a new branch ALWAYS perform the below steps to ensure that when you branch off from master you have the latest upstream version.

To make a branch, do:

git branch <BRANCH_NAME>

Then switch to newly made branch by doing:

git checkout <BRANCH_NAME>

We have switched to a new branch. Now you can make changes to files, add new ones or do whatever you wish.

Step 4: Creating a pull request

After you satisfied with your changes, you can do pull request to the repo.

Add, commit and push your changes by doing:

# Add all the modified files
git add .

# Commit the changes
git commit -m "Commit head message" -m "commit description"

# Update origin remote url to your forked repo
git remote origin set-url https://github.com/<YOUR_GITHUB_USERNAME>/TweaksKM.git

# Verify if url updated correctly
git remote -v

# Push to origin to create a PR
git push origin <BRANCH_NAME>

Now go to your forked repo on github, and pull a request on dev/staging or master branch!

Have a good tittle and description

Adding a reviewer and labels is a good practice!

Congratulations! You have successfully contributed to the project!

Localisation

Contribute to the app by adding different languages strings on it!

the string resource values can be found under /app/src/main/res/values/strings.xml

Here is our Crowdin Page!

Further documentations can be found on Android developers site.

We are looking forward to your contributions!