Malayalam Mozhi Keyman Keyboard

mlym-mozhi-Keyman

Mozhi is one of most popular phonetic keyboarding scheme for Malayalam script. It was originally designed by Cibu for the Varamozhi project and he still maintains the Mozhi specification.

Keyman

This project implements the Mozhi layout in Keyman 9, the popular keyboarding application. Starting from release Keyman 9.0.528.0, the program is again made available as a free program by SIL International after they acquired the rights to Keyman software from Tavultesoft, the company that owned Keyman. This keyboard will support all the Malayalam Characters available in Unicode 10.

How to collaborate on this project

You are welcomed to collaborate in this project. The Keyman keybaord development is not a big task. So even if you are not a developer, you can still contribute to this project. To participate in this project you'll need the Keyman Developer application, which can be downloaded from here. Once you download and install Keyman desktop on your computer, visit the Developer Support page and Keyman Keyboard Languge page to learn more about how to write Keyman Keybaords.

Setting up your system for collaboration

This project is an open source project. That means you are invited to participate in the development of this project. You don't have to be a programmer to participate in this project. If you are excited about this project, you can contribute to this project by [reporting issues], [improving the documentation] or [share about this project].

In this project we will use Git as our Version Control Software. Since you are reading this, you might already know that this project is hosted on GitHub. You should also install a Git client software on your local machine. We will use the Git Forking Workflow for this project. Take a moment to read through this link and learn the workflow and philosophy. If you are new you git and version controlling system, you may want to take the interactive training offered on the Atlasian Website.

Here is an overview of the workflow

• Fork this repository.
• Clone your copy into a convenient location on your computer. (If you haven't already installed a git client download and install one. Once you have a git client installed, open a Command Window (Right click on your folder while holding down the Shift key, and select the option, Open Command Window Here.

C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git clone https://github.com/<your github account name>/mlym-mozhi-Keyman.git

Note: You can alternatively use Git for Windows, "mingw" if you are more familiar with a linux like terminal.

• The Forking workflow requires two remotes (links to the public server repo). One to your own repo, which is already created when you cloned your personal public repo to your local system in the previous step. This remote is normally called the origin. Make a new remote upstream which will allow you to stay updated with the official repo.

C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git remote add upstream https://github.com/beniza/mlym-mozhi-Keyman.git

Now, go ahead and list the remotes to see if everything looks good!

C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git remote -v

origin  https://github.com/<your github account name>/mlym-mozhi.git (fetch)
origin  https://github.com/<your github account name>/mlym-mozhi.git (push)
upstream  https://github.com/beniza/mlym-mozhi.git (fetch)
upstream  https://github.com/beniza/mlym-mozhi.git (push)

• Decide on an issue you wanted to contribute.
  • Please see the Issues page of this repo to see the pending issues. Please make an issue on the repo, if you haven't find the issue you are planning to contribute.
• Create a new branch

C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git branch issue-#
C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git checkout issue-#

Alternatively, you can combine these two steps in one command

C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git checkout -b issue-#

In issue-# replace # with the issue number you are trying to fix.

Now you are ready to make changes to the project. Open the Keyboard file using Keyman Developer. Add necessary changes to the code or documentation. The next step is to check in the changes you have made. Git will keep the track of the changes you are making to the project. By using the following commands, you can let git know that you have finished working on something, and also why you made that change.

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git status # This will list all the files you have made changes.
  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git add <filename> # <filename> specifies the name of the file you have edited.
  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git commit -m "A brief message answering the question, why you made this change" # <filename> specifies the name of the file you have edited.

If you have changed the code, make sure that you test it thoroughly. Refer to the section explaining the testing a Keyman Keyboard to learn how to test your Keyboard.

• Once you are satisfied with the changes made, check in your changes. This is done in several steps.

  • Save your work
  • Open or switch to your terminal window
  • List the files got changed in during the editing process

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git status

This step can help you remind about the changes you've made during your editing process.

• commit your changes

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git commit -a

This will open up a new window, where you can give a commit message describing the changes you have made. Depending on the type of change you are making, this commit message can be a single line summary of the change or a very detailed explanation. For any major updates, we recommend that you include a good commit message that answer three questions about your patch:

Why is it necessary? It may fix a bug, it may add a feature, it may improve performance, reliabilty, stability, or just be a change for the sake of correctness.

How does it address the issue? For short obvious patches this part can be omitted, but it should be a high level description of what the approach was.

What effects does the patch have? (In addition to the obvious ones, this may include benchmarks, side effects, etc.) Read more on Commit messages

• Update your branch with the changes from the official repo. There are several ways you can get your local repo synced with the official repo. Before you send the changes made by you to the server, you should always update your repo with the latest changes on the brach you are working on. In this workflow we will use the rebasing strategy for updating our local repo.

Make sure that you are on your issue branch first

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git checkout issue-#

• rebase the branch you're on onto whatever is on the upstream's master branch (the changes other team members have made since the last time you did this):

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git pull --rebase upstream master

Occassionally you will get a merge conflict at this point. You will have to manually fix any conflicts, before you'll be able to submit a change to the server.

• Resolve any conflicts When you follow the rebasing strategy to maintain the project, Git will update your local branch one commit from the server at a time. As soon as it finds a conflict, it pauses the operation and allow you to fix it. Open the file and resolve the conflicts (Git will highlight the places where the conflict occur by adding >>>. Review the code on your side and the code coming from the server carefully and decide how you want to resolve it by accepting the changes from the server or overwriting it with your code.

Remember that the code coming from the server is reviewed by the project maintainers and if you choose to replace it with your changes, you may have to prove to the reviewing team, why should they accept your code. In any case, expect to have a discussion around this change with the project maintainers/reviewers.

Once you finish editing the file, you can continue the rebase operation by

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git add <filename>
  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git rebase --continue

Continue this operation until all the conflicts have been resolved.

• push your commit to the remote origin

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git push origin issue-#

One of the side effect of rebasing is it actually recreates new versions of each commit you've made on top of your team member's commits. So during a push operation, Git will not recognize your changes as the same as what is already on the origin repo. Therefore it will think your origin is ahead of local, and ask you to pull before pushing. If this happens, you can force Git to overwrite your origin repo with you have locally

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git push -f origin issue-#

• Create a pull request to the upstream

At this point you can visit your repository on github using a browser, and you are ready to make a pull request to the original repository. Click on the New pull request button on the page. Choose your issue-# branch and submit a pull request. Once we receive a pull request, one of us will review the changes and all the relevant changes will be integrated into the project.

• Final step, delete the local branch and update master

Once the project maintainer accept your pull request, you can safely delete your local branch and update the master branch with from the upstream. Before you do this, make sure that you switched to your master branch.

C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git checkout master

To delete the issue-# branch,

C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git branch -d issue-#

And finally update your master branch

  C:\Users\<your windows user name>\Documents\Work\mlym-mozhi-Keyman> git pull --rebase upstream master

That's it. You've made a contribution to the project.

Please visit the wiki page for more info.