You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 18, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+6-7Lines changed: 6 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing To Interactive Git Cheatsheet
1
+
# Contributing To Git Cheats
2
2
3
3
:octocat: Thanks for taking the time to contribute!
4
4
@@ -7,7 +7,7 @@ The following is a set of guidelines for contributing to this repository.
7
7
[Code of Conduct](#code-of-conduct)
8
8
9
9
[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)
11
11
- [Table Of Contents](#table-of-contents)
12
12
-[Code of Conduct](#code-of-conduct)
13
13
-[How Can I Contribute?](#how-can-i-contribute)
@@ -17,7 +17,7 @@ The following is a set of guidelines for contributing to this repository.
17
17
-[Commit Messages](#commit-messages)
18
18
19
19
## 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.
21
21
22
22
## How Can I Contribute?
23
23
### Reporting Bugs
@@ -42,10 +42,9 @@ Unsure where to begin contributing? You can start by looking through these `begi
42
42
### Pull Requests
43
43
While creating a Pull Request, fill out the [the required template](PULL_REQUEST_TEMPLATE.md)
44
44
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
<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.
6
6
</p>
7
7
8
8
<palign="center">
9
9
<img src=".github/splash.png">
10
10
</p>
11
11
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
+
12
21
## Online
13
22
14
23
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:
19
28
2. Run `yarn` to install dependencies
20
29
3. Run `yarn dev` to start server
21
30
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
-
32
31
## Technology
33
32
34
-
- Hosted on [Vercel](https://vercel.com/)♥
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/)
38
35
-[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/)♥
41
+
42
+
For more information, please check [package.json](package.json)
39
43
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.
41
47
42
48
## License
43
49
44
50
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
45
51
46
52
## Other Useful Projects
47
53
48
-
If you think there should be more, please create an issue labeled as `enhancement` and give direct link to the project.
49
-
50
54
-[Git Init](https://pel-daniel.github.io/git-init) - Great learning tool for learning how to use commands
51
55
-[Git - The Simple Guide](https://rogerdudler.github.io/git-guide) - Simple guide for getting started with git
52
56
-[Learn Git Branching](https://learngitbranching.js.org) - Learn how to use branches properly
0 commit comments