Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.97 KB

Contributing to Theoretical-Computer-Science

Thank you for considering contributing to this repository! Your contributions help improve the quality of the notes and lectures provided here. To ensure a smooth collaboration, please follow these guidelines:

How to Contribute

  1. Fork the Repository: Start by forking this repository to your own GitHub account.
  2. Clone the Repository: Clone the forked repository to your local machine.
  3. Create a Branch: Create a new branch for your changes. Use a descriptive name for your branch (e.g., update-lecture-notes, fix-typo).
  4. Make Changes: Make your changes to the code or documentation. Ensure that your changes are well-documented and adhere to the existing style and conventions.
  5. Test Your Changes: If applicable, test your changes to make sure they work as expected.
  6. Commit Your Changes: Commit your changes with a clear and concise commit message.
  7. Push to GitHub: Push your changes to your forked repository on GitHub.
  8. Submit a Pull Request: Open a pull request to merge your changes into the main repository. Provide a detailed description of your changes and any relevant information.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it to understand the expectations for behavior when contributing to this project.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue in the repository. Provide as much detail as possible to help us understand and address the issue.

Style Guide

To maintain consistency, please follow these guidelines when contributing:

  • Use clear and concise language.
  • Comment your code where necessary.
  • Adhere to the existing formatting and style conventions.

Contact

If you have any questions or need further assistance, feel free to reach out by opening an issue or contacting the repository maintainers.

Thank you for your contributions!