Thank you for considering contributing to the SimPy Tutorial! We welcome contributions to improve this tutorial and make it more useful for the community.
There are several ways you can contribute:
👉 Reporting Issues: If you find a bug or have suggestions for improvements, please open an issue on the Issues page.
👉 Submitting Code Changes:
- Fork the Repository: Click on the "Fork" button at the top right of this page to create a copy of this repository in your GitHub account.
- Create a New Branch: Create a new branch for your changes using a descriptive name. For example:
git checkout -b feature/your-feature-name
- Make Changes: Implement your changes or improvements. Ensure that your code adheres to the existing style and conventions used in the project.
- Write Tests: If applicable, write tests to cover your changes and ensure they are working as expected.
- Commit Changes: Commit your changes with a clear and concise message describing what you have done.
git add . git commit -m "Add your descriptive commit message here"
- Push Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name
- Create a Pull Request: Go to the original repository and open a pull request from your branch. Provide a detailed description of your changes and why they are beneficial.
👉 Improving Documentation: Help improve the documentation by suggesting edits or creating new content. You can do this by submitting pull requests or suggesting edits in issues.
Follow these guidelines when contributing:
- Use descriptive commit messages.
- Write clear and concise comments in your code.
- Follow the existing coding style and formatting.
- Ensure that your changes are well-tested.
If you have any questions or need further assistance, feel free to reach out to the maintainers by opening an issue or contacting us directly at [email protected].
Thank you 🙏❤️ for contributing to the SimPy Tutorial!