Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Update release/contribution/quickstart docs #242

Merged
merged 4 commits into from
Sep 27, 2024

Conversation

Jeffwan
Copy link
Collaborator

@Jeffwan Jeffwan commented Sep 26, 2024

Pull Request Description

[Please provide a clear and concise description of your changes here]

Related Issues

Resolves: #[Insert issue number(s)]

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [API]: Modifications to aibrix's API or interface
  • [CLI]: Changes or additions to the Command Line Interface
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

@Jeffwan Jeffwan marked this pull request as ready for review September 26, 2024 21:52
@Jeffwan Jeffwan force-pushed the jiaxin/doc-improvement branch from 6278483 to 3e97d7e Compare September 26, 2024 22:00
@Jeffwan
Copy link
Collaborator Author

Jeffwan commented Sep 26, 2024

image
image
image

@Jeffwan Jeffwan requested a review from xieus September 26, 2024 22:01
Copy link
Collaborator

@xieus xieus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty detailed docs! Very nice work.

@Jeffwan
Copy link
Collaborator Author

Jeffwan commented Sep 27, 2024

@xieus All comments are addressed. PTAL

@Jeffwan
Copy link
Collaborator Author

Jeffwan commented Sep 27, 2024

@xieus I have another PR needs to rebase this change for further modifications. I will merge this one first. If you have more feedback, feel free to leave them here and I can address the comments in later PR

@Jeffwan Jeffwan merged commit 5592c20 into main Sep 27, 2024
10 checks passed
@Jeffwan Jeffwan deleted the jiaxin/doc-improvement branch September 27, 2024 16:20
gangmuk pushed a commit that referenced this pull request Jan 25, 2025
* Add release process

* Update the contributions docs

* Update the architecture part

* Address review feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants