Skip to content

docs: updated readme with squash tips #1481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2018
Merged

docs: updated readme with squash tips #1481

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 41 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ Please join us on the following channels:
## Features
| **Feature** | **Description** | **Status** |
|------------------|-------------------------------------------------------|-----------------|
| Home Screen | Show status and version of PSLab device | ✓ |
| Instruments | Exposes PSLab instruments like Oscilloscope, etc | ✓ |
| Oscilloscope | Shows variation of analog signals | ✓ |
| Multimeter | Measures voltage, current, resistance and capacitance | ✓ |
| Logical Analyzer | Captures and displays signals from digital system | ✓ |
| Wave Generator | Generates arbitrary analog and digital waveforms | ✓ |
| Power Source | Generates programmable voltage and currents | ✓ |
| Lux Meter | Measures the ambient light intensity | ✓ |
| Home Screen | Show status and version of PSLab device | ✓ |
| Instruments | Exposes PSLab instruments like Oscilloscope, etc | ✓ |
| Oscilloscope | Shows variation of analog signals | ✓ |
| Multimeter | Measures voltage, current, resistance and capacitance | ✓ |
| Logical Analyzer | Captures and displays signals from digital system | ✓ |
| Wave Generator | Generates arbitrary analog and digital waveforms | ✓ |
| Power Source | Generates programmable voltage and currents | ✓ |
| Lux Meter | Measures the ambient light intensity | ✓ |


## How to set up the Android app in your development environment
Expand Down Expand Up @@ -122,6 +122,39 @@ Please help us follow the best practice to make it easy for the reviewer as well
* The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
* If the PR is related to any front end change, please attach relevant screenshots in the pull request description.

#### How to `git squash`?

As a tip for new developers those who struggle with squashing commits into one, multiple commits may appear in your pull request mostly due to following reasons.

* Intentionally adding multiple commit messages after each change without just `git add`ing.
* Updating the current branch with the remote so a merge commit takes place.

Despite any reason, follow the steps given below to squash all commits into one adhering to our best practices.

* Setup remote to upstream branch if not set before;

`$ git remote add upstream https://github.com/fossasia/pslab-android.git`

* Check into the branch related to the pull request

`$ git checkout <branch-name>`

* Perform a soft reset to retain the changes while removing all the commit details

`$ git reset --soft upstream/development`

* Add files to the staging area

`$ git add <file paths or "." to add everything>`

* Create a new commit with a proper message following commit message guidelines

`$ git commit -m "tag: commit message"`

* If you have already made a pull request,

`$ git push -f origin <branch-name>`

### Branch Policy

We have the following branches
Expand Down