Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 3.51 KB

contributing.md

File metadata and controls

52 lines (32 loc) · 3.51 KB

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Guidelines

  • Commit message of your pull request should be in the format Add: x, Fix: y, Update: z, Feat: a. Example: Add: Winpower
    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

  • App should be added in this format and it should be added to the bottom of the specific category:

- [NAME](LINK) - DESCRIPTION. ICONS FOR OS AND MORE

Example:

- [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.

    The description should end with a period (.), no other symbols like !, ?, etc. are allowed.

    The description shouldn't start with words like "A", "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.

  • ONLY add your app or make any changes to the README.md file. All other files are auto-generated.

  • 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 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.

Adding something

You'll need a GitHub account!

  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. 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

  3. Now click on the edit icon. Step 3 - Click on Edit

  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. Step 4 - Edit the file

  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes

  6. Submit the pull request!

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 is a write up on how to change a Pull Request and the different ways you can do that.