External/awesome-free-apps
1
0
Fork 0
mirror of https://github.com/Axorax/awesome-free-apps.git synced 2025-12-17 09:45:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Feat: Add guidelines

Browse Source
This commit is contained in:
Axorax 2025-01-30 14:33:41 +06:00
parent 34c084a99f
commit 21adb881b9
2 changed files with 116 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
contributing.md
View File

@ -2,59 +2,131 @@
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
## Guidelines
Read these rules first and then make a PR or contribute. If you don't know how to do that, then check [how-to-contribute.md](how-to-contribute.md)
- Commit message of your pull request should be in the format `Add: x`, `Fix: y`, `Update: z`, `Feat: a`. Example: `Add: Winpower` <br> Use feat if you add new features like adding a new command to the CLI helper app. Use add when adding new apps, and the others pretty much explain themselves
- [Suggesting an app or any support](#suggesting-an-app-or-any-support)
- [Editing the list](#editing-the-list)
- [Code contributions](#code-contributions)
- [Recommended icon requirements](#recommended-icon-requirements)
- [Maintainer guide](#maintainer-guide)
- App should be added in this format and it should be added to the bottom of the specific category:
## Suggesting an app or any support
```
- [NAME](LINK) - DESCRIPTION. ICONS FOR OS AND MORE
```
You can do this in a few ways. Like:
Example:
- Making an issue in the repository. [Click here to make one.](https://github.com/Axorax/awesome-free-apps/issues/new?template=Blank+issue)
- Joining the Discord server and messaging there. [Click here to join.](https://discord.com/invite/nKUFghjXQu)
## Editing the list
- Only modify these files; `README.md`, `MOBILE.md`
`README.md` for desktop apps. <br>
`MOBILE.md` for mobile apps.
- Do not change the order of any apps like ordering alphabetically.
### Adding an app to an existing category
- App should be added like this and it should be added to the **bottom of the specific category**:
```
- [Winpower](https://github.com/Axorax/winpower) - Advanced power settings and management for Windows. 🪟 🟢
```
- Description of the app should be short and only highlight the features. Don't include random nonsense like if your app falls under the "Clipboard Management" category and you write "Software to manage clipboard.", that provides no information about the app. <br><br> The description should end with a period (.), no other symbols like !, ?, etc. are allowed. <br><br> The description shouldn't start with words like "A", "The", etc. Example:
- The icons (emojis) should go after the description. There is a reference table at the top of the README file.
- Description of the app should be short and only highlight the features. Don't include random nonsense like if your app falls under the "Clipboard Management" category and you write "Software to manage clipboard.", that provides no information about the app.
- The description should end with a period (.), no other symbols like !, ?, etc. are allowed.
- The description shouldn't start with words like "A", "An", "The", etc. Example:
```
❌ A lightweight app to do something.
✅ Lightweight app to do something.
```
- The icons (emojis) should go after the description. There is a reference table at the top of the README file.
- When the app is open-source, make the 🟢 icon a link to the source code of the project. If the app has a separate
website, use it as the link for the app name. Otherwise use the source code link for both the name and the icon. Example:
```
```md
- [Neovim](https://neovim.io) - Advanced Vim-based text editor with improved extensibility, plugins, and modern features. 🪟 🍎 🐧 [🟢](https://github.com/neovim/neovim)
- [ungoogled-chromium](https://github.com/ungoogled-software/ungoogled-chromium) - Privacy-focused Chromium with Google services removed. 🪟 🍎 🐧 [🟢](https://github.com/ungoogled-software/ungoogled-chromium)
```
- ONLY add your app or make any changes to the README.md file. All other files are auto-generated.
### Adding a new category
- To add a new category, just make it following the rules for the other ones in the file. DO NOT change anything in the Table of Contents as it is auto-generated. After you make a new category, it will be automatically added in the contents later on.
- Do not create an empty category.
- DO NOT change the order of any apps. You can add your app to the bottom of the category but don't change the order like ordering alphabetically or anything.
- Use `##` for the main category and `###` for sub-categories. Example:
## Adding something
```md
## Audio
You'll need a [GitHub account](https://github.com/join)!
- <example app>
1. Access the GitHub page (https://github.com/axorax/awesome-free-apps). Make sure the app is not in the main list or in [archived.md](archived.md). If it is in archived.md, mention it when you make the PR.
### Music creation
2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png)
4. You can start editing the text of the file in the in-browser editor. Make sure you follow the guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)
5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png)
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
- <example app in a more specific sub-category>
```
## Updating your Pull Request
- For the position, add it after another category that is somewhat related otherwise add it alphabetically.
Sometimes, a maintainer might ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the guidelines stated here.
- Do not modify the table of content. It is auto-generated.
[Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request and the different ways you can do that.
### Commit message
- Use `Add: name` to add a new app.
- Use `Update: name` to update an existing app.
- Use `Remove: name` to remove an app.
You can optionally specify the list for all of them. Examples:
```console
Add: Winpower
Update: Winpower
Remove: Winpower
Add (PC): Inkless
Update (PC): Inkless
Remove (PC): Inkless
Add (MOBILE): Spotify
Update (MOBILE): Spotify
Remove (MOBILE): Spotify
```
## Code contributions
If you make code contributions like modifying the CLI helper app, then follow these rules. You contribution won't be accepted if it:
- Breaks the code of conduct.
- Is only a code refactor.
- Has little to no benefit or effect.
- Breaks the codebase.
For the commit message, use `Feat` for new features, `Update` to modify something. Examples:
```console
Feat: AI to make app with CLI
Update: Format function to be more strict
```
## Recommended icon requirements
- App should have a good GUI.
- Must be optimized depending on the category and functionality. Like if a todo list app uses 1 GB of RAM, that's just annoying.
- App must provide useful functionality.
- Must be from a trustworthy developer or company (Extra points if open-source).
- Should be somewhat popular or well-known.
## Maintainer guide
If you become a maintainer (make an issue if you want to become one), here's a few things to know about:
- Review PRs to make sure people follow the rules in this file.
- You should follow the rules here as well.
- Make sure you abide by the code of conduct.
- In the actions tab, there's an action called `Update main file`. It auto-generates the ToC, filters and a lot more. So, you don't have to do any of that. This action should be run once a week to keep everything upto date.
- You can join the Discord server to make communications easier. [Click here to join.](https://discord.com/invite/nKUFghjXQu)

19
how-to-contribute.md Normal file
View File

@ -0,0 +1,19 @@
# How to contribute?
## Adding something
You'll need a [GitHub account](https://github.com/join)!
1. Access the GitHub page (https://github.com/axorax/awesome-free-apps). Make sure the app is not in the main list or in [archived.md](archived.md). If it is in archived.md, mention it when you make the PR.
2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png)
4. You can start editing the text of the file in the in-browser editor. Make sure you follow the guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)
5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png)
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
## Updating your Pull Request
Sometimes, a maintainer might ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the guidelines stated here.
[Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request and the different ways you can do that.