Thank you for considering contributing to our System Design repository! We welcome contributions from the community to help improve and expand our resources. Please follow these guidelines to ensure a smooth contribution process.
-
Fork the Repository: Start by forking the repository to your GitHub account.
-
Clone the Repository: Clone the forked repository to your local machine.
git clone https://github.com/your-username/system-design.git
-
Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b feature/your-feature-name
-
Make Changes: Implement your changes in the new branch. Ensure your code follows the repository's coding standards and best practices.
-
Commit Changes: Commit your changes with a clear and concise commit message.
git commit -m "Add feature: your feature description"
-
Push Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name
-
Create a Pull Request: Open a pull request to the main repository. Provide a detailed description of your changes and any relevant information.
Please adhere to our Code of Conduct in all your interactions with the project.
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 problem.
- Follow the existing code style and conventions.
- Write clear and concise commit messages.
- Document your code where necessary.
Ensure that your changes do not break existing functionality. If applicable, add tests to cover your changes.
By contributing to this repository, you agree that your contributions will be licensed under the repository's MIT License.
Thank you for your contributions!