search

Tencent / tquic

A high-performance, lightweight, and cross-platform QUIC library
https://tquic.net/
Other
1.02k stars 82 forks source link

Code contribution process testing #324

Closed Thuwzq closed 1 month ago

Thuwzq commented 1 month ago

Code contribution process testing

glime-ai[bot] commented 1 month ago

The process for contributing code to TQUIC involves several steps, including creating a branch, making changes, and submitting a pull request. Here are the key steps and requirements for testing during the code contribution process:

  1. Create and Switch to a New Branch:

    • Use the command git checkout -b my-cool-stuff to create and switch to a new branch.
    • Ensure the current branch directory is clean before checkout to avoid bringing untracked files to the new branch.

  2. Build and Test:

    • Follow the Installation guide for building and testing.
    • Ensure all unit tests pass successfully. If any test fails, the code will not be reviewed.

  3. Commit Changes:

    • Use git add <file> to stage changes and git commit to commit them.
    • Provide a clear and concise commit message to inform other developers about the changes.

  4. Submit a Pull Request:

    • Switch to the branch you created and click New pull request.
    • Include a note like resolve #Issue number in the pull request description to automatically close the corresponding issue after the merge.
    • Wait for the review and make necessary modifications if required.

  5. Pass Unit Tests:

    • Every new commit in your pull request will trigger CI unit tests.
    • Ensure that necessary comments are included in your commit message.
    • Green ticks indicate that your commit has passed all unit tests, while a red cross indicates a failure. Click on the details to view bug details and add a screenshot of the bug as a comment in your pull request for assistance.

  6. Delete Branches:

    • After your pull request is successfully merged, you can delete the remote branch using git push origin :the_branch_name.
    • Delete the local branch using git checkout develop and git branch -D my-cool-stuff.

For more detailed information, you can refer to the following sources:

This comment was generated by Glime.