Thank you for considering contributing to this project! We welcome all contributions, whether it's bug fixes, feature enhancements, documentation improvements, or anything else that helps make this project better.
- Fork the Repository: Click the "Fork" button on the top-right of the repository page to create your copy.
- Clone the Forked Repository: Clone your fork to your local machine using:
git clone https://github.com/Witthayanuraks/wafeport.git cd react-vite-template
- Install Dependencies: Run the following command to install all necessary dependencies:
npm install
- Create a New Branch: Before making changes, create a new branch:
git checkout -b feature-or-fix-name
To start the development server with Hot Module Replacement (HMR), run:
npm run dev
- Follow the existing project structure and coding style.
- Use ESLint to check for linting issues before committing:
npm run lint
- Ensure that any new dependencies are necessary before adding them.
- Make Your Changes: Implement your changes following the guidelines above.
- Commit Your Changes:
git add . git commit -m "feat: add feature or fix"
- Push Your Branch:
git push origin feature-or-fix-name
- Create a Pull Request (PR):
- Go to the original repository on GitHub.
- Click on "New Pull Request."
- Select your branch and compare it with the
main
branch. - Provide a clear description of the changes made.
- Submit the PR for review.
- Check open issues before submitting a new one to avoid duplicates.
- When reporting a bug, provide steps to reproduce it.
- Feel free to start a discussion if you have any ideas or questions!
By contributing, you agree that your contributions will be licensed under the MIT License.
Thank you for your contribution! 🎉