Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 2.87 KB
Raw

Contributing to Reactfolio

Thank you for considering contributing to Reactfolio! We welcome contributions from everyone. By contributing to this project, you help improve it and get your contributions recognized on ORCID. This guide will help you get started with the contribution process.

Project Overview

Reactfolio is a customizable portfolio template designed for developers looking to showcase their work with style and simplicity. The project has two main branches:

  • main: Handles deployment with Node.js installation and automatic deployment to GitHub Pages using GitHub Actions.
  • docker-deploy: (Deprecated) Docker support is no longer provided from version v1.8.0 onwards. For users who still wish to use Docker, please refer to the docker-deploy branch documentation for detailed instructions. Note that we will not handle any issues related to Docker from this version onwards.

How to Contribute

We welcome contributions from everyone. By contributing to this project, you help improve it and get your contributions recognized on ORCID. This guide will help you get started with the contribution process.

1. Fork the Repository

Start by forking the repository to create your own copy on GitHub.

  1. Click the Fork button at the top-right corner of the repository page.
  2. This will create a copy of the repository under your GitHub account.

2. Clone the Forked Repository

Clone the forked repository to your local machine.

git clone https://github.com/<your-username>/Reactfolio.git
cd Reactfolio

3. Create a New Branch

Create a new branch for your changes. Make sure to base your branch on the main branch.

git checkout -b <your-branch-name> main

4. Make Your Changes

Make the necessary changes to the codebase. Ensure that your changes are well-documented and tested.

5. Commit Your Changes

Commit your changes with a clear and descriptive commit message following the conventional commit format.

git add .
git commit -m "feat: add new feature description"

6. Push Your Changes

Push your changes to your forked repository.

git push origin <your-branch-name>

7. Open a Pull Request

Open a pull request (PR) from your branch to the main branch of the original repository.

  1. Go to the original repository on GitHub.
  2. Click on the Pull requests tab.
  3. Click the New pull request button.
  4. Select your branch and the target branch (main).
  5. Provide a clear and descriptive title and description for your PR.
  6. Click Create pull request.

ORCID Recognition

By contributing to this project, you help improve it and get your contributions recognized on ORCID, enhancing your profile in academia.

Thank you for contributing to Reactfolio! Your contributions help make this project better for everyone.