Skip to content

Latest commit

 

History

History
122 lines (77 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

122 lines (77 loc) · 3.73 KB
Raw

Contributing to Terminal Portfolio

Welcome to the Terminal Portfolio project! We appreciate your interest in contributing to our open-source project.

Please take a moment to review the following guidelines to ensure a smooth and positive contribution process.

First time contributor? Don't worry! We will help you throughout the process. Feel free to ask any questions you may have. We are here to help! :)

Table of Contents

  1. Getting Started
  2. Making Contributions
  3. Submitting Pull Requests
  4. Review Process
  5. Attribution

Getting Started

Find an Issue

  • Go to issues and find an issue that you can solve.
  • Comment on the issue that you want to solve it.

Fork the Repository

Click the "Fork" button on the top right corner of this repository's page to create a copy of the project in your GitHub account. You'll be making your contributions in your forked repository.

Clone the Repository

Clone your forked repository to your local machine using the following command:

git clone https://github.com/<your-username>/terminal-portfolio.git

Set Up the Development Environment

Install the project's dependencies:

npm install

Run the project locally:

npm run dev

Making Contributions

Branching

Create a new branch for your feature or bug fix:

git checkout -b feature-name

Writing Code

Make your changes to the codebase. Please follow the coding conventions and standards used throughout the project. Make sure to write meaningful comments in your code.

Documentation

Update the documentation if your changes impact the project's user or developer documentation.

This includes updating README files, code comments, or any other relevant documentation.

Commit Messages

Please follow conventional commit messages for your commits. This helps in generating meaningful changelogs automatically.

You can use the following command to commit your changes:

git commit -m "fixes: #0000"

Pushing Changes

Before pushing your changes, make sure to pull the latest changes from the main repository's main branch:

git pull origin main

Push your changes to your forked repository:

git push origin feature-name

Testing

We don't have any tests yet. Please check your code manually before submitting a PR.

Submitting Pull Requests

When you're ready to submit your changes, create a pull request (PR) from your feature branch to the main repository's main branch. Be sure to include a clear and descriptive title and a detailed description of your changes.

Review Process

Once you've submitted a PR, maintainers and contributors will review your code, provide feedback, and request changes if necessary. Be prepared to address these comments and make necessary revisions.

Attribution

Contributors will be credited for their contributions in the project's documentation. Thank you for your valuable contributions to Terminal Portfolio!

Note: This CONTRIBUTING.md file is a guideline. The project maintainers may have specific requirements or procedures that override these general instructions. Always refer to the project's own CONTRIBUTING.md if it exists.