Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

105 lines (81 loc) · 2.95 KB

Contributing to Portfolio Project

Thank you for considering contributing to the Portfolio project! Your contributions are valuable and help improve the quality and functionality of this project. This guide outlines how you can get involved.

How Can I Contribute?

1. Reporting Issues

If you find any bugs, glitches, or have suggestions for improvements:

  • Check the Issues tab to see if it has already been reported.
  • If not, open a new issue and include:
    • A clear and descriptive title.
    • Steps to reproduce the issue (if applicable).
    • Screenshots or error messages for better context.
    • Suggestions for potential fixes or improvements (optional).

2. Suggesting Features

If you have ideas for new features:

  • Open an issue labeled as enhancement.
  • Clearly explain:
    • The purpose and benefits of the feature.
    • How it would fit into the existing project.

3. Making Code Contributions

Follow these steps to contribute code:

  1. Fork the Repository

    • Click the "Fork" button on the top-right of this repository.
    • Clone your forked repository to your local machine: 
      git clone https://github.com/psparwez/portfolio.git

  2. Create a Branch
    Use a descriptive name for your branch:

    git checkout -b feature/your-feature-name

  3. Make Changes

  • Implement your changes, keeping them aligned with the project's style and structure.
  • Ensure your code is well-documented and easy to understand.
  • Test your changes locally.
  1. Commit Your Changes
  • Use clear and concise commit messages:
git add .
git commit -m "Add [brief description of your changes]"
  1. Push Your Changes Push your changes to your fork:
git push origin feature/your-feature-name
  1. Create a Pull Request
  • Navigate to the original repository: Portfolio Repository.
  • Click on "Compare & pull request."
  • Provide a detailed explanation of:
  • The changes you made.
  • The reason for your contribution.
  • Submit your pull request for review.

Code Guidelines

  • Follow the coding style and conventions used in the project.
  • Write clean, modular, and reusable code.
  • Include comments to explain the purpose of complex code.
  • Ensure compatibility with the current Next.js framework and libraries used in the project.

Development Environment

Prerequisites Node.js (v18 or higher) npm or yarn Setting Up

  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

Testing

  • Verify your changes by testing the application locally.
  • Ensure no existing functionality is broken.

Feedback and Questions

If you have questions or need clarification, feel free to:

  • Open a discussion in the Discussions tab.
  • Reach out to the repository owner via email or social channels listed in the project's README.

Thank you for contributing! Your efforts help make this project better for everyone. 🎉