louiscklaw/HKSingleParty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
efe70ceb69e4ff17c0ff24d3d9578c214be46137
HKSingleParty/03_source/api_server.del/CONTRIBUTING.md
louiscklaw efe70ceb69 init commit,
2025-05-28 09:55:51 +08:00

3.2 KiB
Raw Blame History

Contributing to prisma-express-typescript-boilerplate

Thank you for your interest in contributing to the prisma-express-typescript-boilerplate project! Your contributions are valuable in making this project better for everyone. Before you start contributing, please take a moment to review the guidelines below.

Getting Started

  1. Fork the Repository: Start by forking the prisma-express-typescript-boilerplate repository to your own GitHub account. You can do this by clicking the "Fork" button on the repository page.

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

git clone https://github.com/your-username/prisma-express-typescript-boilerplate.git

  1. Install Dependencies: Navigate to the cloned repository directory and install the project dependencies by running:

npm install

Making Changes

  1. Create a Branch: Create a new branch for your changes. Use a descriptive name that reflects the nature of your contribution. For example:

git checkout -b my-contribution

  1. Implement Your Changes: Make the necessary modifications and improvements to the project. This could involve bug fixes, feature enhancements, documentation updates, or any other relevant changes.

  2. Test Your Changes: Ensure that your modifications work as intended and don't introduce any regressions. Run the existing tests using:

npm test

If you're adding new features, consider writing tests to cover the new functionality.

  1. Commit Your Changes: Once you're satisfied with your changes, commit them with a clear and descriptive commit message:

git add .

git commit -m "Add my contribution

  1. Push Your Changes: Push your changes to your forked repository:

Submitting a Pull Request

  1. Open a Pull Request: Go to the main page of your forked repository on GitHub and switch to the branch you just pushed. Click on the "Compare & pull request" button next to the branch name.

  2. Provide a Description: In the pull request description, clearly explain the purpose and details of your contribution. Reference any relevant issues or feature requests if applicable.

  3. Review Process: The project maintainers will review your pull request, providing feedback or suggesting changes if necessary. Be open to discussion and iterate on your changes based on the feedback received.

  4. Merge Your Pull Request: Once your pull request has been approved and passes the review process, it will be merged into the main repository. Congratulations on your successful contribution!

Code of Conduct

Please note that the prisma-express-typescript-boilerplate project follows a Code of Conduct. Respectful and inclusive behavior is expected from all contributors. Familiarize yourself with the project's Code of Conduct to ensure a positive and welcoming environment for everyone.

Getting Help

If you have any questions or need assistance during the contribution process, don't hesitate to reach out to the project maintainers by opening an issue on the repository. They will be happy to help you.

Thank you for your interest in contributing to the prisma-express-typescript-boilerplate project. Your contributions make a difference!