git-market/jaywcjlove-awesome-mac
1
0
Fork 0
mirror of https://github.com/jaywcjlove/awesome-mac.git synced 2026-04-11 14:21:52 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
master
jaywcjlove-awesome-mac/docs/CONTRIBUTING.md
小弟调调 8b8f3c7b97
Some checks are pending
GitHub Actions Build and Deploy awesome-mac / build-deploy (push) Waiting to run
Details
Add awesome-mac maintainer skill
2026-04-11 14:15:29 +08:00

4.1 KiB
Raw Permalink Blame History

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

Table of Contents

Pull Request Guidelines

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions to make sure your suggestion isn't a duplicate.
  • Make sure each list item is useful before adding it.
  • Create individual pull requests/issues for each suggestion.
  • Use title-casing (AP style) in the following format: [List Name](link)
  • Link additions should be added in alphabetical order in the relevant category.
  • New categories or changes to the existing categorization are welcome.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request and commit should have a useful title.
  • Annotate your PR to clarify what you did if the diff is confusing.

AI-assisted contributions

AI-assisted contributions are welcome, but they should follow the same repository rules as manual edits.

This repository includes a Codex skill at .codex/skills/awesome-mac-maintainer for multilingual curation tasks. If you use Codex or a compatible agent, prefer $awesome-mac-maintainer when adding, updating, or reclassifying app entries.

The skill is designed to help contributors:

  • choose the most appropriate category based on comparable existing entries
  • keep descriptions concise and limited to one sentence
  • sync entries across README.md, README-zh.md, README-ja.md, and README-ko.md
  • preserve local section structure, alphabetical ordering, and existing icon style

Example prompts:

Use $awesome-mac-maintainer to add this app to README.md, README-zh.md, README-ja.md, and README-ko.md.

Use $awesome-mac-maintainer to check whether this app belongs in Screen Recording or Screenshot Tools, then update the four README files.

If you use AI without this skill, please still make sure the final PR follows the repository's category, ordering, wording, and multilingual sync rules.

Thank you for your suggestions!

How to add to this list

If you have something awesome to contribute to this list, this is how you do it.

If you have a GitHub account:

  1. Fork this repo.
  2. Make changes under correct section in README.md
  3. Update Contents (if applicable)
  4. Commit and open a Pull Request

If you don't have a GitHub account, make one!

  1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
  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 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 of an awesome list will 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 awesome-* list guidelines.

Here is a write up on how to change a Pull Request, and the different ways you can do that.