Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (88 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

128 lines (88 loc) · 3.27 KB

Contributing to ProXIcons

Welcome to the ProXIcons open-source project! We're thrilled that you're considering contributing to our growing collection of developer-friendly icons.

ProXIcons is built by the community, for the community. Whether you're an experienced designer, a developer, or a newcomer eager to help, there's a place for you here.

Table of Contents

  1. Getting Started
  2. Ways to Contribute
  3. Contribution Guidelines
  4. Creating and Submitting Icons
  5. Improving Documentation
  6. Pull Request Process
  7. Code of Conduct
  8. Need Help?

Getting Started

1. Fork the Repository

Click the Fork button on the top right of the ProXIcons GitHub page. This creates your own copy of the repository.

2. Clone the Forked Repository

git clone https://github.com/your-username/ProXIcons.git
cd ProXIcons

3. Create a Feature Branch

git checkout -b feature/your-feature-name

Ways to Contribute

  • Add new SVG icons
  • Optimize or improve existing icons
  • Fix bugs or improve structure
  • Improve or expand the documentation
  • Create web-based demos or integrations
  • Suggest new ideas or open issues for discussion

Contribution Guidelines

Icon Design Guidelines

  • Format: SVG (Scalable Vector Graphics)
  • Size: Maintain a canvas size of 24x24 or 32x32 pixels
  • Style: Consistent line width and pixel alignment
  • Naming: Use lowercase and dashes (icon-name.svg)
  • Optimization: Remove unnecessary metadata using SVGO

Coding & Documentation

  • Keep your code clean and follow existing patterns.
  • Document your icons/components if needed in docs/.
  • Test all changes locally before committing.

Creating and Submitting Icons

  1. Place your SVG file inside the icons/ directory.
  2. Follow naming conventions: icon-name.svg
  3. Preview and test your icon in a browser or editor.
  4. Add usage examples in the docs/index.html file if necessary.

Improving Documentation

You can help us by enhancing documentation:

  • Fixing typos or grammar
  • Adding examples or explanations
  • Creating usage guides or tutorials
  • Updating icon references

Documentation is located primarily in the docs/ folder.

Pull Request Process

  1. Ensure your branch is up to date with main:
git pull origin main
  1. Commit your changes with a clear message:
git add .
git commit -m "Add: new icon 'star-outline'"
  1. Push your branch and open a Pull Request:
git push origin feature/your-feature-name
  1. Wait for review. We may ask for changes before merging.

Code of Conduct

We follow a friendly, inclusive, and respectful code of conduct. Please be respectful in all interactions and communications.

Need Help?

If you're stuck or unsure, don't hesitate to:

  • Open an issue
  • Reach out via discussions
  • Tag your PRs with questions

Thank you for being a part of the ProXIcons community! Your contribution makes a difference.

— Team ProXentix