Skip to content

Commit

Permalink
developer_manual README.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
wonkr committed Mar 8, 2024
1 parent b887289 commit c4bb410
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/developer_manual/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ There are several ways you can contribute to SEED emulator:

## Getting Started

1. **Fork the Repository**: Fork the [Your Package Name] repository on GitHub by clicking the "Fork" button.
1. **Fork the Repository**: Fork the `seed-emulator` repository on GitHub by clicking the "Fork" button.
2. **Clone the Repository**: Clone your fork of the repository to your local machine using `git clone`.
3. **Switch to the Development Branch**: Checkout the development branch of the repository using `git checkout development`.
4. **Create a Branch**: Create a new branch for your contribution using `git checkout -b branch-name`.
Expand All @@ -46,13 +46,12 @@ There are several ways you can contribute to SEED emulator:

## Code Style and Guidelines

Please follow these guidelines when contributing code to [Your Package Name]:
Please follow these guidelines when contributing code to `seed-emulator`:

- **Docstrings**: Document your code using clear and concise docstrings following the numpydoc format.
- **Testing**: Write comprehensive unit tests for your code using the `unittest` framework.
- **Modularity**: Keep your changes modular and avoid unnecessary dependencies.
- **Compatibility**: Ensure your code is compatible with the supported Python versions.
- **Pylint**: Code Quality --> still working on it.


## Licensing
Expand Down

0 comments on commit c4bb410

Please sign in to comment.