Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.73 KB

Contributing to Awesome Zed

Thank you for your interest in contributing to Awesome Zed! Your help is appreciated. By contributing to this project, you agree to abide by our Code of Conduct.

How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new, descriptively named branch for your changes. See our branch naming convention below.
  4. Add your link to the appropriate category in README.md.
  5. Commit your changes using a Conventional Commit message format (e.g., feat: Add [Resource Name]).
  6. Push your branch to your fork.
  7. Create a Pull Request from your fork to the main awesome-zed repository.

Branch Naming Convention

Please name your branches using the following convention, inspired by Conventional Commits:

  • feat/branch-name: For new features or additions (e.g., adding a new theme).
  • fix/branch-name: For bug fixes (e.g., correcting a broken link).
  • docs/branch-name: For changes to documentation.
  • chore/branch-name: For maintenance tasks, refactoring, etc.

Example: git checkout -b feat/add-catppuccin-theme

Contribution Guidelines

  • Please keep lists alphabetically sorted.
  • Please search the list to avoid duplicate entries.
  • Use the following format for your entry: - [Resource Name](https://example.com/) - A brief, but descriptive, sentence about the resource.
  • Ensure your link is to the official or primary source for the resource.
  • Check your spelling and grammar.
  • The link should be working and the resource should be of high quality.
  • Make sure your pull request has a descriptive title.

Thank you for your contribution!