kepka/.github/CONTRIBUTING.md

Contributing

This document describes how you can contribute to Kepka. Please read it carefully.

Table of Contents

• What contributions are accepted
• Build instructions
• Pull upstream changes into your fork regularly
• How to get your pull request accepted
  • Keep your pull requests limited to a single issue
    • Squash your commits to a single commit
  • Don't mix code changes with whitespace cleanup
  • Keep your code simple!
  • Test your changes!
  • Write a good commit message

What contributions are accepted

We highly appreciate your contributions in the matter of fixing bugs and optimizing the Kepka source code and its documentation. In case of fixing the existing user experience please push to your fork and submit a pull request.

Wait for us. We try to review your pull requests as fast as possible. If we find issues with your pull request, we may suggest some changes and improvements.

Unfortunately we do not merge any pull requests that have not comply with Telegram API Terms of Use.

Kepka is a fork of a Telegram Desktop which a part of Telegram project, so all the decisions about the features, languages, user experience, user interface and the design in upstream are made inside Telegram team, often according to some roadmap which is not public.

Build instructions

See the README.md for details on the various build environments.

Pull upstream changes into your fork regularly

Kepka is advancing quickly. It is therefore critical that you pull upstream changes into your fork on a regular basis. Nothing is worse than putting in a days of hard work into a pull request only to have it rejected because it has diverged too far from upstram.

To pull in upstream changes:

git remote add upstream https://github.com/procxx/kepka.git
git fetch upstream master

Check the log to be sure that you actually want the changes, before merging:

git log upstream/master

Then rebase your changes on the latest commits in the master branch:

git rebase upstream/master

After that, you have to force push your commits:

git push --force

For more info, see GitHub Help.

How to get your pull request accepted

We want to improve Kepka with your contributions. But we also want to provide a stable experience for our users and the community. Follow these rules and you should succeed without a problem!

Keep your pull requests limited to a single issue

Pull requests should be as small/atomic as possible. Large, wide-sweeping changes in a pull request will be rejected, with comments to isolate the specific code in your pull request. Some examples:

• If you are making spelling corrections in the docs, don't modify other files.
• If you are adding new functions don't 'cleanup' unrelated functions. That cleanup belongs in another pull request.

Squash your commits to a single commit

To keep the history of the project clean, you should make one commit per pull request. If you already have multiple commits, you can add the commits together (squash them) with the following commands in Git Bash:

1. Open Git Bash (or Git Shell)
2. Enter following command to squash the recent {N} commits: git reset --soft HEAD~{N} && git commit (replace {N} with the number of commits you want to squash)
3. Press i to get into Insert-mode
4. Enter the commit message of the new commit
5. After adding the message, press ESC to get out of the Insert-mode
6. Write :wq and press Enter to save the new message or write :q! to discard your changes
7. Enter git push --force to push the new commit to the remote repository

For example, if you want to squash the last 5 commits, use git reset --soft HEAD~5 && git commit

Don't mix code changes with whitespace cleanup

If you change two lines of code and correct 200 lines of whitespace issues in a file the diff on that pull request is functionally unreadable and will be rejected. Whitespace cleanups need to be in their own pull request.

Keep your code simple!

Please keep your code as clean and straightforward as possible. Furthermore, the pixel shortage is over. We want to see:

• opacity instead of o
• placeholder instead of ph
• myFunctionThatDoesThings() instead of mftdt()

Test your changes!

Before you submit a pull request, please test your changes. Verify that Kepka still works and your changes don't cause other issue or crashes.

Write a good commit message

• Explain why you make the changes. More infos about a good commit message.

• If you fix an issue with your commit, please close the issue by adding one of the keywords and the issue number to your commit message.

  For example: Fix #545

• For documentation commits add [ci skip] (or [skip ci]) at the end of the commit message.

Commit Message Example

Summarize changes in around 50 characters or less

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789
[ci skip]

(Example taken from this source)