Contribution Guidelines

Learn how to contribute to Portfolio Ideas and help us grow our collection of inspiring portfolios.

Thank you for your interest in contributing to Portfolio Ideas! These guidelines will help you understand how to submit portfolios, report issues, or contribute to our codebase.

Submitting Portfolios

Help us grow our collection by submitting outstanding portfolio websites.

Submission Criteria

We're looking for high-quality, creative, and inspiring portfolio websites from developers and designers. Before submitting, please ensure the portfolio meets the following criteria:

Design Quality

The portfolio should demonstrate good design principles, be visually appealing, and provide a good user experience.

Technical Implementation

The code should be well-structured, follow best practices, and demonstrate technical proficiency.

Originality

The portfolio should showcase creativity and originality in its approach to presenting the developer's work.

Accessibility

The portfolio should follow accessibility best practices to ensure it's usable by everyone.

How to Submit

To submit a portfolio for consideration, please follow these steps:

Fill out the submission form on our Contact page, selecting "Portfolio Submission" as the subject.
Include the following information:
- Portfolio owner's name
- Live URL of the portfolio
- GitHub repository URL (if available)
- Technologies used (e.g., React, Vue, TailwindCSS)
- Brief description of what makes this portfolio special
Provide a high-quality screenshot of the portfolio's homepage or most impressive section.

Please ensure you have permission to submit someone else's portfolio if it's not your own. We respect intellectual property rights and will only feature portfolios with proper attribution.

Contributing to the Codebase

Help improve Portfolio Ideas by contributing to our open-source codebase.

Getting Started

Portfolio Ideas is an open-source project, and we welcome contributions from developers of all skill levels. Here's how to get started:

Fork the repository on GitHub.

Clone your fork to your local machine:

git clone https://github.com/yourusername/portfolio-ideas.git

Install dependencies:
```
cd portfolio-ideas npm install
```
Create a new branch for your feature or bug fix:
```
git checkout -b feature/your-feature-name
```
Make your changes and commit them with descriptive commit messages.

Push your changes to your fork:

git push origin feature/your-feature-name

Create a pull request from your fork to the main repository.

Code Style and Standards

To maintain code quality and consistency, please follow these guidelines:

Follow the existing code style and formatting.
Write clear, descriptive commit messages.
Include comments for complex logic or functionality.
Write tests for new features or bug fixes when applicable.
Ensure your code is accessible and responsive.

Pull Request Process

When submitting a pull request, please:

Provide a clear description of the changes and their purpose.
Reference any related issues using the GitHub issue number (e.g., "Fixes #123").
Ensure all tests pass and there are no conflicts with the main branch.
Be responsive to feedback and be prepared to make requested changes.

We appreciate all contributions, no matter how small! Even fixing a typo or improving documentation is valuable to the project.

Reporting Issues

Help us improve by reporting bugs, suggesting features, or asking questions.

How to Report Issues

If you encounter a bug, have a feature request, or want to suggest an improvement, please:

Check existing issues to see if your problem or suggestion has already been reported.
Create a new issue on our GitHub repository if your issue hasn't been reported.
Use a descriptive title that clearly summarizes the issue.
Provide detailed information about the issue, including:
- Steps to reproduce (for bugs)
- Expected behavior
- Actual behavior
- Screenshots or videos (if applicable)
- Browser and operating system information
Use issue templates when available to ensure you provide all necessary information.

Feature Requests

We welcome suggestions for new features or improvements. When submitting a feature request, please:

Clearly describe the feature and its purpose.
Explain how the feature would benefit users of Portfolio Ideas.
Provide examples or mockups if possible.
Indicate if you're willing to help implement the feature.

Your feedback helps us improve Portfolio Ideas. We review all issues and feature requests, though we may not be able to implement every suggestion immediately.

Ready to Contribute?

We're excited to see your contributions! Whether you're submitting a portfolio, reporting an issue, or contributing code, your help makes Portfolio Ideas better for everyone.

Submit a Portfolio View on GitHub