Skip to content

Commit

Permalink
Port of PR 1813: Replace yapf with black (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
AgrawalAmey authored May 27, 2024
1 parent 6e5c568 commit f101990
Show file tree
Hide file tree
Showing 115 changed files with 2,943 additions and 2,815 deletions.
46 changes: 46 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
FILL IN THE PR DESCRIPTION HERE

FIX #xxxx (*link existing issues this PR will resolve*)

**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE**

---

<details>
<!-- inside this <details> section, markdown rendering does not work, so we use raw html here. -->
<summary><b> PR Checklist (Click to Expand) </b></summary>

<p>Thank you for your contribution to Vidur! Before submitting the pull request, please ensure the PR meets the following criteria. This helps Vidur maintain the code quality and improve the efficiency of the review process.</p>

<h3>PR Title and Classification</h3>
<p>Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:</p>
<ul>
<li><code>[Bugfix]</code> for bug fixes.</li>
<li><code>[CI/Build]</code> for build or continuous integration improvements.</li>
<li><code>[Doc]</code> for documentation fixes and improvements.</li>
<li><code>[Model]</code> for adding a new model or improving an existing model. Model name should appear in the title.</li>
<li><code>[Profiling]</code> For changes on the profiling module. </li>
<li><code>[Core]</code> for changes in the core simulator logic </li>
<li><code>[Misc]</code> for PRs that do not fit the above categories. Please use this sparingly.</li>
</ul>
<p><strong>Note:</strong> If the PR spans more than one category, please include all relevant prefixes.</p>

<h3>Code Quality</h3>

<p>The PR need to meet the following code quality standards:</p>

<ul>
<li>Pass all linter checks. Please use <code>make format</code></a> to format your code.</li>
<li>The code need to be well-documented to ensure future contributors can easily understand the code.</li>
<li>Please add documentation to <code>docs/source/</code> if the PR modifies the user-facing behaviors of Vidur. It helps user understand and utilize the new features or changes.</li>
</ul>

<h3>Notes for Large Changes</h3>
<p>Please keep the changes as concise as possible. For major architectural changes (>500 LOC), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with <code>rfc-required</code> and might not go through the PR.</p>

<h3>Thank You</h3>

<p> Finally, thank you for taking the time to read these guidelines and for your interest in contributing to Vidur. Your contributions make Vidur a great tool for everyone! </p>


</details>
26 changes: 26 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: "Run linter"
on:
push:
branches: [main]
pull_request:
branches: [main]
permissions:
contents: read
packages: write
defaults:
run:
shell: bash -l {0}
jobs:
sanity_check:
runs-on: "ubuntu-latest"
steps:
- name: "Checkout Repository"
uses: actions/checkout@v3
- name: Install Conda environment from environment-dev.yml
uses: mamba-org/setup-micromamba@v1
with:
environment-file: environment-dev.yml
- name: "Run black lint"
run: make lint/black
- name: "Run isort check"
run: make lint/isort
30 changes: 0 additions & 30 deletions .github/workflows/yapf.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ celerybeat.pid
# Environments
.env
.venv
env*
env/
env_sarathi/
env_flashinfer/
env_flashinfer_2/
Expand Down
Loading

0 comments on commit f101990

Please sign in to comment.