Skip to content

Tips and Tricks Main Chapter Landing page #17

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

Draft
chuanhao01 wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Tips and Tricks Main Chapter Landing page #17

Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
378845e
adding Inital draft of main chapter README
chuanhao01 Sep 27, 2020
21f5a30
format table in main README
chuanhao01 Sep 27, 2020
143dace
adding short contribution steps for adding tips
chuanhao01 Sep 27, 2020
b6be631
adding subchapter requirement in readme
chuanhao01 Sep 28, 2020
dede5ad
adding rule and date completed section
chuanhao01 Sep 28, 2020
35c1e00
added reference part for sub-chapter requirements
chuanhao01 Sep 28, 2020
c64fe28
Apply suggestions from code review
chuanhao01 Oct 31, 2020
f05a906
Some minor changes for clarity
chuanhao01 Oct 31, 2020
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
22 changes: 22 additions & 0 deletions 09-tips-and-tricks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Tips and Tricks

This chapter will be about some common tips and tricks you can use for your git setup.
These tips can be something as simple and generic as using bash aliases to someting very specific and complex, like integrating the `vscode` editor with git.

Below is a quick reference table for all the tips in this guide.
You can refer to their respecitve sub-chapter guides for more information.

| Tip | Description | Author | Date Completed | Link |
|-------|------------------|-----------------------------|----------------|--------------------------|
| Tip 1 | Some Description | [@author](#tips-and-tricks) | 01/01/2020 | [Link](#tips-and-tricks) |

## Contributing a tip

On top of following the guidelines in the [contributing](../CONTRIBUTING.md) document for a tip's sub-chapter, you should also:
- Make sure the tip is added as a sub-chapter folder (You can use other tips or chapter's 7 sub-chapters as a reference)
- Make sure you add a short description, the date when the guide was finished(Inital finished date) and a link to the quick reference table above.
- Make sure the quick reference table is formatted properly (You can use [this](http://markdowntable.com/) website)
- Make sure the tip's sub-chapter updates are noted at the bottom of the tip
- Make sure the tip's references are given (if any)
- Make a Pull Request indicating the tip you are adding