Skip to content

Latest commit

 

History

History
137 lines (118 loc) · 6.1 KB

CONTRIBUTING.md

File metadata and controls

137 lines (118 loc) · 6.1 KB
Raw

Getting Started

Contributing Guidelines contributions welcome

When contributing to this repository, please first discuss the change you wish to make via an issue.

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. If you have got any questions, please ask on Zulip Channel. You can join our zulip channel to chat about your queries in real-time.

Submitting or Requesting an Issue/Enhancement

Best Practices for reporting or requesting for Issues/Enhancements:

  • Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
  • Follow the Issue Template while creating the issue.
  • Include Screenshots if any (specially for UI related issues).
  • For UI enhancements or workflows, include mockups to get a clear idea.

Best Practices for getting assigned to work on an Issue/Enhancement:

  • If you would like to work on an issue, inform in the issue ticket by commenting on it.
  • Please be sure that you are able to reproduce the issue, before working on it. If not, please ask for clarification by commenting or asking the issue creator.

Note: Please do not work on an issue which is already being worked on by another contributor. We don't encourage creating multiple pull requests for the same issue. Also, please allow the assigned person at least 2 days to work on the issue (The time might vary depending on the difficulty). If there is no progress after the deadline, please comment on the issue asking the contributor whether he/she is still working on it. If there is no reply, then feel free to work on the issue.

Submitting a Pull Request

Best Practices to send Pull Requests:

  • Fork the project on GitHub
  • Clone the project locally into your system.
git clone https://github.com/your-username/search_guru.git
  • Make sure you are in the master branch.
git checkout master
  • Create a new branch with a meaningful name before adding and commiting your changes.
git checkout -b branch-name
  • Add the files you changed. (avoid using git add .)
git add file-name

git commit
  • If you forgot to add some changes, you can edit your previous commit message.
git commit --amend
  • Squash multiple commits to a single commit. (example: squash last two commits done on this branch into one)
git rebase --interactive HEAD~2
  • Push this branch to your remote repository on GitHub.
git push origin branch-name
  • If any of the squashed commits have already been pushed to your remote repository, you need to do a force push.
git push origin remote-branch-name --force
  • Follow the Pull request template and submit a pull request with a motive for your change and the method you used to achieve it to be merged with the master branch.
  • If you can, please submit the pull request with the fix or improvements including tests.
  • During review, if you are requested to make changes, rebase your branch and squash the multiple commits into one. Once you push these changes the pull request will edit automatically.

Configuring remotes

When a repository is cloned, it has a default remote called origin that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote called upstream.

  1. Set the upstream.
git remote add upstream https://github.com/aashish-ak/search_guru.git
  1. Use git remote -v to check the status. The output must be something like this:
  > origin    https://github.com/your-username/search_guru.git (fetch)
  > origin    https://github.com/your-username/search_guru.git (push)
  > upstream  https://github.com/aashish-ak/search_guru.git (fetch)
  > upstream  https://github.com/aashish-ak/search_guru.git (push)
  1. To update your local copy with remote changes, run the following: (This will give you an exact copy of the current remote. You should not have any local changes on your master branch, if you do, use rebase instead.)
git fetch upstream
git checkout master
git merge upstream/master
  1. Push these merged changes to the master branch on your fork. Ensure to pull in upstream changes regularly to keep your forked repository up to date.
git push origin master
  1. Switch to the branch you are using for some piece of work.
git checkout branch-name
  1. Rebase your branch, which means, take in all latest changes and replay your work in the branch on top of this - this produces cleaner versions/history.
git rebase master
  1. Push the final changes when you're ready.
git push origin branch-name

How to Commit

After your Pull Request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository.

  1. Delete the remote branch on GitHub.
git push origin --delete branch-name
  1. Checkout the master branch.
git checkout master
  1. Delete the local branch.
git branch -D branch-name
  1. Update your master branch with the latest upstream version.
git pull upstream master

That's it! Thank you for your contribution!

Author - Shamelessly copied from Mifos-Foundation.