Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (93 loc) · 5.9 KB

CONTRIBUTING.md

File metadata and controls

139 lines (93 loc) · 5.9 KB

Contributing to 1chooo.com

Welcome to the 1chooo.com repository! We're glad you're interested in contributing to our React portfolio project. By contributing, you help make our project better and more useful for everyone. Below are some guidelines to get you started.

Table of Contents

Issues

If you encounter any issues, have suggestions, or want to report a bug, feel free to create an issue. When creating an issue, please include a clear and descriptive title, along with relevant details about the problem or suggestion. This will help us understand and address the issue more effectively.

Pull Requests

We welcome contributions through pull requests! If you're working on a bug fix, new feature, or improvements, follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name:
    • For bug fixes: fix/issue-number-fix-description
    • For features: feature/description-of-feature
  3. Make your changes and commit following the Conventional Commits guidelines.
  4. Push your changes to your forked repository.
  5. Open a pull request from your branch to the main branch of the original repository.
  6. Make sure you run pnpm test before submitting your pull request to ensure there are no issues.

Setup

Forking this Repository:

Fork the 1chooo/1chooo.com repository into your own workspace.

Cloning the Repository to Your Workspace:

$ git clone git@github.com:<your_workspace_name>/1chooo.com.git

Setting Upstream Remote:

$ git remote add upstream git@github.com:1chooo/1chooo.com.git

$ git remote -v
origin  git@github.com:<your_user_name>/1chooo.com.git (fetch)
origin  git@github.com:<your_user_name>/1chooo.com.git (push)
upstream        git@github.com:1chooo/1chooo.com.git (fetch)
upstream        git@github.com:1chooo/1chooo.com.git (push)

Pull Requests:

If you have any valuable ideas to contribute, please create a pull request and provide details about the outstanding work you've done.

Important

Make sure to synchronize and update your repository before writing any code.

  1. Run git stash save to temporarily stash your local changes.
  2. Run git fetch upstream to sync the source project with your local copy.
  3. Run git checkout main to switch to the main branch.
  4. Run git merge upstream/main to merge the updated remote version into your local copy. If there are no conflicts, the update process is complete.
  5. Run git stash pop to apply your temporarily stashed changes back to your working directory. Resolve any conflicts if necessary.

Getting Started

This project was bootstrapped with Create React App.

sudo npx create-react-app . --template typescript

Available Scripts

In the project directory, you can run:

pnpm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

pnpm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

pnpm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

pnpm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Conventional Commits

We follow the Conventional Commits specification for commit messages. This helps us maintain a clear and organized commit history. Your commit messages should be formatted as follows:

<type>(<scope>): <description>

For example:

  • feat(homepage): add new hero section
  • fix(styles): correct header alignment