Skip to content
This repository was archived by the owner on Jul 18, 2023. It is now read-only.

Commit f02087d

Browse files
committed
Improve README.md and CONTRIBUTING.md
1 parent 2cd197b commit f02087d

File tree

2 files changed

+29
-26
lines changed

2 files changed

+29
-26
lines changed

‎.github/CONTRIBUTING.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing To Interactive Git Cheatsheet
1+
# Contributing To Git Cheats
22

33
:octocat: Thanks for taking the time to contribute!
44

@@ -7,7 +7,7 @@ The following is a set of guidelines for contributing to this repository.
77
[Code of Conduct](#code-of-conduct)
88

99
[How Can I Contribute?](#how-can-i-contribute)
10-
- [Contributing To Interactive Git Cheatsheet](#contributing-to-interactive-git-cheatsheet)
10+
- [Contributing To Git Cheats](#contributing-to-interactive-git-cheatsheet)
1111
- [Table Of Contents](#table-of-contents)
1212
- [Code of Conduct](#code-of-conduct)
1313
- [How Can I Contribute?](#how-can-i-contribute)
@@ -17,7 +17,7 @@ The following is a set of guidelines for contributing to this repository.
1717
- [Commit Messages](#commit-messages)
1818

1919
## Code of Conduct
20-
This project and everyone participating in it is governed by the [Interactive Git Cheatsheet Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
20+
This project and everyone participating in it is governed by the [Git Cheats Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
2121

2222
## How Can I Contribute?
2323
### Reporting Bugs
@@ -42,10 +42,9 @@ Unsure where to begin contributing? You can start by looking through these `begi
4242
### Pull Requests
4343
While creating a Pull Request, fill out the [the required template](PULL_REQUEST_TEMPLATE.md)
4444

45-
* With v1.1.0 you can add complicated commands!
46-
* **Do not** change design into a complicated and / or overwhelming piece of junk
47-
* **Do not** include issue numbers in the PR title
48-
* **Include** screenshots or animated GIFs in your pull request whenever possible
45+
* **Do not** change design into a complicated and / or overwhelming experience
46+
* **Do not** include issue numbers in the PR title if any
47+
* **Include** screenshots or animated GIFs in your pull request if a new feature
4948

5049

5150
### Commit Messages

‎README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
11
<p align="center">
2-
<h1 align="center">Git Cheats • <i>Interactive Git Cheatsheet</i></h1>
2+
<h1 align="center">Git Cheats • Interactive Git Cheatsheet</h1>
33
</p>
44
<p align="center">
5-
<b>Git Cheats</b> aims to ease the pain while transitioning from sluggish GUI clients to blazing-fast terminal commands
5+
<b>Git Cheats</b> aims to ease the pain while transitioning from sluggish GUI clients to blazing-fast terminal commands. It is not a direct replacement for the original documentation, but a companion for beginners.
66
</p>
77

88
<p align="center">
99
<img src=".github/splash.png">
1010
</p>
1111

12+
## Features
13+
With Git Cheats you can;
14+
- Easily search for commands
15+
- Filter a group of commands by category
16+
- Copy usage examples to paste into your terminal
17+
- Click any command name to launch the original documentation
18+
- If you are looking for more advanced commands, you can toggle the advanced button and display even more commands
19+
20+
1221
## Online
1322

1423
You can find and bookmark the online version from [git-cheats.vercel.app](https://git-cheats.vercel.app)
@@ -19,34 +28,29 @@ You can find and bookmark the online version from [git-cheats.vercel.app](https:
1928
2. Run `yarn` to install dependencies
2029
3. Run `yarn dev` to start server
2130

22-
## How To Contribute
23-
24-
Please feel free to contribute any way you can. Just keep in mind that you should pay attention to [CONTRIBUTE.md](.github/CONTRIBUTING.md) before contributing.
25-
26-
That being said, you can;
27-
28-
- Create issues for feature requests and issues
29-
- Create pull requests for any fixes / additions
30-
- Create pull requests for localizations
31-
3231
## Technology
3332

34-
- Hosted on [Vercel](https://vercel.com/) &hearts;
35-
- [Bootstrap](https://getbootstrap.com/)
36-
- [Next.js](https://nextjs.org/)
37-
- [React](https://reactjs.org/)
33+
- [ReactJS](https://reactjs.org/)
34+
- [NextJS](https://nextjs.org/)
3835
- [SWR](https://swr.vercel.app/)
36+
- [Bootstrap](https://getbootstrap.com/)
37+
- [Eslint](https://eslint.org/)
38+
- [Prettier](https://prettier.io/)
39+
- [Husky](https://typicode.github.io/husky/)
40+
- Hosted on [Vercel](https://vercel.com/) &hearts;
41+
42+
For more information, please check [package.json](package.json)
3943

40-
You can find the rest in [package.json](package.json)
44+
## How To Contribute
45+
46+
Please feel free to contribute any way you can. Just keep in mind that you should pay attention to [CONTRIBUTE.md](.github/CONTRIBUTING.md) before contributing.
4147

4248
## License
4349

4450
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
4551

4652
## Other Useful Projects
4753

48-
If you think there should be more, please create an issue labeled as `enhancement` and give direct link to the project.
49-
5054
- [Git Init](https://pel-daniel.github.io/git-init) - Great learning tool for learning how to use commands
5155
- [Git - The Simple Guide](https://rogerdudler.github.io/git-guide) - Simple guide for getting started with git
5256
- [Learn Git Branching](https://learngitbranching.js.org) - Learn how to use branches properly

0 commit comments

Comments
 (0)