Welcome to the honghong.me repository! We're glad you're interested in contributing to our Next.js blog project. By contributing, you help make our project better and more useful for everyone. Below are some guidelines to get you started.
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.
We welcome contributions through pull requests! If you're working on a bug fix, new feature, or improvements, follow these steps:
- Fork the repository.
- Create a new branch with a descriptive name:
- For bug fixes:
fix/issue-number-fix-description - For features:
feature/description-of-feature
- For bug fixes:
- Make your changes and commit following the Conventional Commits guidelines.
- Push your changes to your forked repository.
- Open a pull request from your branch to the
mainbranch of the original repository.
To set up the project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/tszhong0411/honghong.me.git cd honghong.me -
Install dependencies using yarn:
yarn install
-
Start the development server:
yarn run dev
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 sectionfix(styles): correct header alignment
Before submitting a pull request, make sure your code is properly formatted. You can use the following commands to format your code:
-
Run lint fixes:
yarn lint:fix
-
Format code:
yarn run format
Make sure your changes are well-tested and your code follows best practices. Thank you for contributing to honghong.me! 🚀