Skip to content

Commit

Permalink
Added instructions on how to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
shaungunaw committed Dec 31, 2024
1 parent 1a467e4 commit 7532193
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
22 changes: 22 additions & 0 deletions Contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing to the Repository

We welcome contributions to the repository! Of course, your contributions will be credited. If you’d like to add solutions in a language of your choice, or amend an existing solution in any language, here’s how you can contribute.

1. Let me know what you plan to contribute! The best way to do this is by joining our discord server (see page 2 of the book). Communication is important to prevent you labouring on a set of quesitons that someone's already working on.

2. Once you've been approved, **fork the repository** to start working on your own solutions locally.

3. Take a close look at how the Python solutions are organized. Your contributions should align with this structure (e.g., folder organization, file naming).

4. Always **create a new branch** for your additions or changes. We recommend creating separate branches for each chapter or feature you’re contributing. Example: `git checkout -b java-solutions-linked-lists`.

5. Stay true to existing code comments and structure. Feel free to add additional comments for clarity, especially if any language-specific nuances are included.

6. **Test your code**. Be sure your code runs. We're currently working on making all test cases public. In the mean time, please use your own set of diverse test cases.

7. **Open a pull request** (PR) and clearly describe your work in the PR. Respond to comments and make necessary adjustments when requested. Once approved, your PR will be merged!

## Questions or Issues?
If you encounter any issues or have questions about contributing, feel free to reach out via the discord, or email us at [email protected].

We greatly appreciate you helping us build this repository and making it accessible to more people. Thank you for contributing!
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ visiting our website to practice all 101 problems. Engaging with these problems
going to reinforce your learning, and better prepare you for high‐stakes coding interviews:\
https://bit.ly/run-code

## Contributing to the Repo
We welcome contributions to the repository! Of course, your contributions will be credited. If you’d like to add solutions in a language of your choice, or amend an existing solution in any language, please read the instructions provided in [Contribute.md](Contribute.md).

## 📙 About the Book

Coding interviews are tough, and they're only getting tougher, typically demanding months of preparation. What we all want is a way to master algorithms and data structures without having to spend countless hours sifting through endless, unfocussed resources. Introducing "Coding Interview Patterns," your complete guide to mastering the key patterns needed to ace your next coding interview.<br />
Expand Down Expand Up @@ -56,6 +59,7 @@ Alex Xu is a software engineer and author. His book 'System Design Interview - A
**Shaun Gunawardane**\
Shaun Gunawardane is a competitive programmer with experience at Google. As a founder of a not-for-profit coding program, he has helped hundreds of students secure software engineering positions at leading companies like Google, Amazon, and Jane Street.


## 📞 Contact

If you have comments or questions about this repository, feel free to contact us at [email protected].
Expand Down

0 comments on commit 7532193

Please sign in to comment.