contribution guidelines (#2)

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contribution Guidelines
+
+Thank you for considering contributing to DEPA for Training! We appreciate your interest and welcome any help you can provide. To ensure a smooth and effective collaboration, please review the following guidelines before getting started.
+
+## Getting Started
+
+1. **Fork the Repository:**
+   - Fork the [DEPA for Training](https://github.com/ispirt/depa-training) repository on GitHub.
+   - Clone your forked repository to your local machine:
+     ```
+     git clone https://github.com/your-username/depa-training.git
+     ```
+
+2. **Branching:**
+   - Create a new branch for your contribution:
+     ```
+     git checkout -b feature/your-feature
+     ```
+
+3. **Development:**
+   - Make your changes and ensure that your code follows our coding standards.
+   - Include relevant documentation if needed.
+
+4. **Testing:**
+   - Run existing tests and/or create new ones to validate your changes.
+   - Ensure that your changes do not break existing functionality.
+
+5. **Committing:**
+   - Commit your changes with a clear and descriptive commit message:
+     ```
+     git commit -m "Add your meaningful message here"
+     ```
+
+6. **Pushing:**
+   - Push your changes to your forked repository:
+     ```
+     git push origin feature/your-feature
+     ```
+
+7. **Pull Request:**
+   - Open a pull request on the [DEPA for Training](https://github.com/ispirt/depa-training) and provide a detailed description of your changes.
+   - Reference any relevant issues in your pull request.
+
+## Contribution Guidelines
+
+1. **Coding Standards:**
+   - Follow the existing coding style and conventions used in the project.
+   - Adhere to the language-specific best practices.
+
+2. **Documentation:**
+   - Include clear and concise documentation for any new features or changes.
+   - Update existing documentation as needed.
+
+3. **Testing:**
+   - Write tests for new functionality and ensure that existing tests pass.
+   - Test your changes across different environments if applicable.
+
+4. **Issue Tracker:**
+   - Check the [issue tracker](https://github.com/ispirt/depa-training/issues) for open issues.
+   - If you plan to work on an issue, comment on it to let others know.
+
+5. **Be Respectful:**
+   - Be respectful to other contributors and maintain a positive and inclusive atmosphere.
+
+## Review Process
+
+1. All contributions will be reviewed by the maintainers.
+2. Feedback and discussions may occur during the review process.
+3. Once approved, your contribution will be merged into the main branch.
+
+Thank you for contributing to DEPA Training! Your efforts help make this project better for everyone.

README.md

@@ -10,8 +10,14 @@ Clone this repo as follows, and follow [instructions](./scenarios/covid/README.m
 git clone --recursive http://github.com/iSPIRT/depa-training
 ```
 
-You can also use Github codespaces using the [dev container](./.devcontainer/devcontainer.json) to create a development environment. Please ensure you allocate at least 64GB disk space in your codespace. Also, run the following command in the Codespace to update submodules.
+You can also use Github codespaces to create a development environment. Please ensure you allocate at least 64GB disk space in your codespace. Also, run the following command in the Codespace to update submodules.
 
 ```bash
 git submodule update --init --recursive
-```
+```
+
+# Contributing
+
+This project welcomes feedback and contributions. Before you start, please take a moment to review our [Contribution Guidelines](./CONTRIBUTING.md). These guidelines provide information on how to contribute, set up your development environment, and submit your changes.
+
+We look forward to your contributions and appreciate your efforts in making DEPA Training better for everyone.