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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-32Lines changed: 1 addition & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,44 +1,13 @@
1
1
# Contributing to cli-tips
2
2
3
-
Thank you for considering contributing to cli-tips! We welcome contributions from everyone. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
3
+
Thank you for considering contributing to cli-tips! We welcome contributions from everyone.
4
4
5
5
## How to Contribute
6
6
7
7
### Reporting Issues
8
8
9
9
If you encounter any issues or have suggestions for improvements, please [open an issue on GitHub](https://github.com/cli-stuff/cli-tips/issues/new/choose). Provide as much detail as possible to help us understand and address the problem.
10
10
11
-
### Adding Translations for Tips
12
-
13
-
We appreciate your help in adding translations for tips. Follow these steps to add a new translation:
14
-
15
-
1.**Fork the Repository**: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.
16
-
17
-
2.**Clone the Repository**: Clone the forked repository to your local machine using the following command:
3.**Create a New Branch**: Create a new branch for your translation using the following command:
23
-
```bash
24
-
git checkout -b add-translation-<language-code>
25
-
```
26
-
27
-
4.**Add Translation File**: Navigate to the `translations` directory and add a new file named `<language-code>.txt` (e.g., `es.txt` for Spanish). Add your translations to this file, following the format of existing translation files.
28
-
29
-
5.**Commit Your Changes**: Commit your changes with a descriptive commit message using the following commands:
30
-
```bash
31
-
git add translations/<language-code>.txt
32
-
git commit -m "Add translations for <language>"
33
-
```
34
-
35
-
6.**Push Your Changes**: Push your changes to your forked repository using the following command:
36
-
```bash
37
-
git push origin add-translation-<language-code>
38
-
```
39
-
40
-
7.**Create a Pull Request**: Go to the original repository on GitHub and click the "New Pull Request" button. Select your branch and submit the pull request. Provide a clear description of the changes you made.
41
-
42
11
### Code Style
43
12
44
13
Please follow these guidelines to maintain a consistent code style:
Copy file name to clipboardExpand all lines: README.md
+1-69Lines changed: 1 addition & 69 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,13 @@
4
4
5
5

6
6
7
-
<p>
8
-
9
7
`cli-tips` is a command-line tool offering useful Linux tips and commands, which can be integrated as a **Message of the Day** (MOTD).
10
8
11
-
</p>
12
-
13
9
</div>
14
10
15
11
## ✨ Features
16
12
17
13
- Displays helpful Linux command tips
18
-
- Supports multiple languages
19
14
- Easy to install and use
20
15
21
16
## 📥 Installation
@@ -70,26 +65,6 @@ cli-tips
70
65
# Use 'uniq' to remove duplicate lines from a file
71
66
```
72
67
73
-
> [!NOTE]
74
-
>
75
-
> `cli-tips` automatically detects the user's language and displays tips in that language. You can also set the language manually using the `LANG` environment variable.
76
-
77
-
### Use Another Language
78
-
79
-
To display tips in a different language, use the `--lang` option:
80
-
81
-
```bash
82
-
cli-tips --lang=uk
83
-
# Output: Використовуйте 'uniq', щоб видалити дубльовані рядки з файлу
84
-
```
85
-
86
-
You can also use the `LANG` environment variable:
87
-
88
-
```bash
89
-
LANG=de cli-tips
90
-
# Output: Verwenden Sie 'uniq', um doppelte Zeilen aus einer Datei zu entfernen
91
-
```
92
-
93
68
### Use the `--about` Flag
94
69
95
70
To display a random tip containing a specific keyword, use the `--about` option:
@@ -101,49 +76,6 @@ cli-tips --about=git
101
76
102
77
If no tips contain the specified keyword, no tip will be output.
103
78
104
-
### Available Languages
105
-
106
-
Here is a list of all available languages:
107
-
108
-
| Language | Code |
109
-
| ----------------------------------- | :--: |
110
-
|[🇸🇦 Arabic](translations/ar.txt)|`ar`|
111
-
|[🇨🇳 Chinese](translations/cn.txt)|`cn`|
112
-
|[🇩🇪 German](translations/de.txt)|`de`|
113
-
|[🇬🇧 English](translations/en.txt)|`en`|
114
-
|[🇮🇷 Farsi](translations/fa.txt)|`fa`|
115
-
|[🇮🇹 Italian](translations/it.txt)|`it`|
116
-
|[🇯🇵 Japanese](translations/ja.txt)|`ja`|
117
-
|[🇰🇷 Korean](translations/ko.txt)|`ko`|
118
-
|[🇵🇱 Polish](translations/pl.txt)|`pl`|
119
-
|[🇪🇸 Spanish](translations/es.txt)|`es`|
120
-
|[🇺🇦 Ukrainian](translations/uk.txt)|`uk`|
121
-
122
-
<!-- ### Specify a Custom Folder with Tips Translations
123
-
124
-
To use a custom folder with tips translations, set the `TIPS_FOLDER` environment variable:
By default, `cli-tips` uses the built-in tips folder. The custom folder should contain text files in the following format:
132
-
133
-
```plaintext
134
-
tips_<lang_id>.txt
135
-
```
136
-
137
-
Example:
138
-
139
-
```plaintext
140
-
📂 translations/
141
-
├── 📄 tips_de.txt
142
-
├── 📄 tips_en.txt
143
-
├── 📄 tips_pl.txt
144
-
└── 📄 tips_uk.txt
145
-
``` -->
146
-
147
79
## 📝 License
148
80
149
81
This project is fully free and you can do anything you want with it, even without mentioning this repository or license. Enjoy! 🚀
@@ -154,4 +86,4 @@ If you like this project, consider supporting it by starring ⭐ it on GitHub, s
154
86
155
87
## 🤝 Contributing
156
88
157
-
We welcome contributions from everyone. If you would like to contribute, please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed instructions on how to add translations and other contributions.
89
+
We welcome contributions from everyone. If you would like to contribute, please read our [CONTRIBUTING.md](CONTRIBUTING.md)
0 commit comments