Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions assets/banner.css

This file was deleted.

5 changes: 0 additions & 5 deletions assets/fonts.css

This file was deleted.

31 changes: 0 additions & 31 deletions assets/layout.css

This file was deleted.

6 changes: 6 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ This ongoing project results from the collaboration and contributions of the peo
* [Chun Him Lee](https://www.linkedin.com/in/chun-him-lee-01b553129/): Coding and review
* [Tu Minh Phuong Doan](https://www.linkedin.com/in/harry-doan-legopher/): Coding and review
* [Yixun Quan](https://www.linkedin.com/in/yixun-quan-929a661a3): Coding and review
* Yuqing Luo: Coding, code maintenance and review
* Wenshu lyu: Coding, code maintenance and review
* Ziqi Liu: Coding, code maintenance and review
* Tianchi Liu: Coding, code maintenance and review
* Qian Liu: Coding, code maintenance and review
* Feng Wang: Coding, code maintenance and review

## Acknowledgment

Expand Down
43 changes: 28 additions & 15 deletions docs/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ git clone https://github.com/Your Account name/clima.git
cd clima
```

Install the dependencies using pipenv. You will need to have pipenv installed on your machine. If you do not have it yet, please refer to [pipenv installation guide](https://pipenv.pypa.io/en/latest/#install-pipenv-today).

```bash
pipenv sync --dev
````

Set up the upstream repository and check the output repositories.

```bash
Expand Down Expand Up @@ -77,6 +83,7 @@ Available [here](code_of_conduct.md)

## Code style

### Code Formatting
We use ruff to enforce the code style and code formatting. You can run it with:

```bash
Expand All @@ -96,17 +103,17 @@ pipenv run pre-commit run --all-files
Hence, you will need to make sure that the code is formatted correctly before committing your changes; otherwise, the commit will fail.
More information about pre-commit hooks can be found [here](https://pre-commit.com/).

Install Black:
### Code Simplicity
Strive to minimize redundancy in your code.
- Keep logic as concise as possible.
- Remove unused variables, imports, and components.
- Prefer reusable utilities to repeated patterns.

```bash
pipenv install black
```

Format your code before committing:

```bash
black .
```
### UI Modifications
For UI-related changes:
* Use [DMC (Dash Mantine Components)](https://www.dash-mantine-components.com/) wherever applicable for layout and styling consistency.
* Do not use CSS, only inline styles are allowed, but still try to minimize their use.
* Ensure visual consistency with existing components.

## Testing

Expand All @@ -115,15 +122,13 @@ Before submitting a Pull Request, please make sure:
- You have installed project dependencies:

```bash
pipenv sync
pipenv sync --dev
```

From the root directory, run:
- Run tests using pytest:

```bash
cd tests/node

npx cypress run
pipenv run pytest
```

## Submitting changes
Expand Down Expand Up @@ -172,6 +177,14 @@ Classification of Common Commit Types:

- **Testing:** Describe how you tested your changes and how we can reproduce them. Include test details if necessary.

**Pull Request Review:**

- After submitting a Pull Request (PR), please @Coderabbit for review.
- Check all improvement suggestions provided by Coderabbit before requesting a final review.

**Discussion of Solutions:**
When needed, seek feedback from collaborators Toby and Giobetti before making major design or logic decisions.


## Thanks

Expand Down
Loading
Loading