From c4bb410bebc719ef8f8bc027f91cd411f203cc01 Mon Sep 17 00:00:00 2001 From: wonkr Date: Fri, 8 Mar 2024 10:41:55 -0600 Subject: [PATCH] developer_manual README.md update --- docs/developer_manual/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/developer_manual/README.md b/docs/developer_manual/README.md index 76c8292ce..25aa28e12 100644 --- a/docs/developer_manual/README.md +++ b/docs/developer_manual/README.md @@ -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`. @@ -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