Thanks for your interest in contributing to this project! Contributions of all kinds are welcome and encouraged, whether in the form of code, documentation, discussion on issues, or something else.
If you're new to this project, start with a good first issue to get a feel for how the repository works. We try to maintain a backlog of relatively straightforward tasks that are well-defined and scoped.
If you'd like to contribute more regularly, join the Code Chronicles server on Discord! The server is private, but you can contact @miorel for an invite, via the email listed in the repository's git log.
Important
If you decide to work on an issue, comment on it, so others are aware. This will avoid duplicated work as well as give the maintainers a chance to offer their assistance if needed.
Changes to the repository are proposed via GitHub pull requests.
We recommend using GitHub's command-line interface, as it will simplify the GitHub workflow. Specifically, you can:
- Clone this repository directly, without needing a fork at this point:
# Many repositories require forking, but we can save that for later.
git clone https://github.com/code-chronicles-code/leetcode-curriculum.git- Make your changes on a local branch and commit them:
# Create and check out a new branch!
git checkout -b some-cool-stuff
# After making some changes:
git commit -am "A descriptive message"- Use the GitHub CLI to create a pull request. The GitHub CLI can fork the repository for you and set everything up.
# You should only have to do this once:
gh auth login
# This is how you can create pull requests from now on.
# Pick the option that creates a fork.
gh pr createIf you prefer not to use the GitHub CLI, you can still create a pull request by any other means you like. Take a look at the GitHub docs on creating a pull request and creating a pull request from a fork.
By contributing to this GitHub repository, you agree to license your contributions under the MIT license.