Update README.md
Browse files
README.md
CHANGED
|
@@ -224,58 +224,3 @@ if __name__ == "__main__":
|
|
| 224 |
print(f"obs: {obs}, reward: {reward}")
|
| 225 |
# Plug this into your RL loop / logging as needed
|
| 226 |
```
|
| 227 |
-
|
| 228 |
-
|
| 229 |
-
## For Contributors
|
| 230 |
-
### Precommit Setup
|
| 231 |
-
|
| 232 |
-
We use Google docstring format for our docstrings and the pre-commit library to check our code. To install pre-commit, run the following command:
|
| 233 |
-
|
| 234 |
-
```bash
|
| 235 |
-
conda install pre-commit # or pip install pre-commit
|
| 236 |
-
pre-commit install
|
| 237 |
-
```
|
| 238 |
-
|
| 239 |
-
The pre-commit hooks will run automatically when you try to commit changes to the repository.
|
| 240 |
-
|
| 241 |
-
|
| 242 |
-
### Commit Message Guidelines
|
| 243 |
-
All commit messages should be clear, concise, and follow this format:
|
| 244 |
-
```
|
| 245 |
-
<type>: <short summary>
|
| 246 |
-
|
| 247 |
-
[optional body explaining the change]
|
| 248 |
-
```
|
| 249 |
-
Recommended types:
|
| 250 |
-
+ feat: A new feature
|
| 251 |
-
+ fix: A bug fix
|
| 252 |
-
+ docs: Documentation changes
|
| 253 |
-
+ refactor: Code restructuring without behavior changes
|
| 254 |
-
+ style: Code style changes (formatting, linting)
|
| 255 |
-
+ test: Adding or updating tests
|
| 256 |
-
+ chore: Non-code changes (e.g., updating dependencies)
|
| 257 |
-
|
| 258 |
-
Example:
|
| 259 |
-
```
|
| 260 |
-
feat: add user login API
|
| 261 |
-
```
|
| 262 |
-
|
| 263 |
-
### Issue Guidelines
|
| 264 |
-
+ Use clear titles starting with [Bug] or [Feature].
|
| 265 |
-
+ Describe the problem or request clearly.
|
| 266 |
-
+ Include steps to reproduce (for bugs), expected behavior, and screenshots if possible.
|
| 267 |
-
+ Mention your environment (OS, browser/runtime, version, etc.).
|
| 268 |
-
|
| 269 |
-
### Pull Request Guidelines
|
| 270 |
-
+ Fork the repo and create a new branch (e.g., feature/your-feature, fix/bug-name).
|
| 271 |
-
+ Keep PRs focused: one feature or fix per PR.
|
| 272 |
-
+ Follow the project’s coding style and naming conventions.
|
| 273 |
-
+ Test your changes before submitting.
|
| 274 |
-
+ Link related issues using Fixes #issue-number if applicable.
|
| 275 |
-
+ Add comments or documentation if needed.
|
| 276 |
-
|
| 277 |
-
We appreciate clean, well-described contributions! 🚀
|
| 278 |
-
|
| 279 |
-
## Star History
|
| 280 |
-
|
| 281 |
-
[](https://www.star-history.com/#SimWorld-AI/SimWorld&type=date&legend=bottom-right)
|
|
|
|
| 224 |
print(f"obs: {obs}, reward: {reward}")
|
| 225 |
# Plug this into your RL loop / logging as needed
|
| 226 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|