LeetCode Rust contribution guidelines

Thank you for your interest in making this project better! We'd love to have your contribution. We expect all contributors to abide by the Rust code of conduct, which you can find at that link or in the CODE_OF_CONDUCT.md file in this repository.

License

This project is dual licenced under the MIT and Apache 2.0 licenses, and so are all contributions. Please see the LICENSE-MIT and LICENSE-APACHE files in this directory for more details.

Pull Requests

To make changes to this project, please send in pull requests on GitHub to the master branch. We'll review them and either merge or request changes. Github CI tests everything as well, so you may get feedback from it too.

If you make additions or other changes to a pull request, feel free to either amend previous commits or only add new ones, however you prefer. We may ask you to squash your commits before merging, depending.

Issue Tracker

You can find the issue tracker on GitHub. If you've found a problem, please open an issue there.

We use the following labels:

enhancement: This is for any request for improve any submitted solutions.
discussion: A discussion about improving/solving problems ; this may lead to new enhancement.
P-Easy: This refers to an easy to solve problem.
P-Medium: This refers to a medium to solve problem.
P-Hard: This refers to a hard to solve problem.

Contributing workflow

install Rust.
Fork this project to your github account.
then clone it localy.

$ git clone https://github.com/{YOUR_GITHUB_USERNAME}/leetcode-rs
$ cd leetcode-rs

Pick one of Leetcode problems here.
Check if there is any Issues/PRs for that problem or not. (if not then continue)
Create a new git branch with problem name. e.g:

$ git checkout -b two-sum

Make a new Cargo project (as a library) named after problem name in one of (easy, medium, hard) directory depending on the level of the picked problem. e.g

$ cargo new --lib --vcs none ./easy/two-sum

Add your project to the Cargo Workspace in Cargo.toml file
Start writing your code.
Run tests localy. e.g:

$ cargo test -p two-sum

Add your solved problem list in the README.md file located in one of (easy, medium, hard) directory depending on the level of this problem. e.g: in easy/README.md

- [Two Sum](https://leetcode.com/problems/two-sum/) See [#1)[https://github.com/shekohex/leetcode-rs/pull/1]

Commit your changes once you are happy with it.
Create a new PR with your changes to the master branch.
Delete your local branch (optinal). e.g:

$ git branch -D two-sum

Thank you ❤️

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!