Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 2.16 KB

Contributing to awesome-golang-algorithm

awesome-golang-algorithm is an open source project.

It is the work of hundreds of contributors. We appreciate your help!

Here are instructions to get you started. They are probably not perfect, please let us know if anything feels wrong or incomplete

Contribution guidelines

Pull requests

This repository Pull Request only support develop branch

First of all. awesome-golang-algorithm follow the gitflow. So please send you pull request to develop branch. We will close the pull request to master branch.

We are always happy to receive pull requests and do our best to review them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it.

If your pull request is not accepted on the first try, don't be discouraged! Sometimes we can make a mistake, please do more explaining for us. We will appreciate it.

We're trying very hard to keep awesome-golang-algorithm simple and fast. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. But we will give you some advice on how to do it in another way.

Standard Process

  • 1.Fork the Repositories awesome-golang-algorithm
  • 2.Check out the branch to develop
  • 3.Find the LeetCode problem directory. if the directory doesn't exist you can copy [src/0000.Demo] and rename it to Standard
  • 4.Write your code int the Solution.go and copy the official test cases in the Solution_test.go
  • 5.Update the README.MD file. if you want
  • 6.Update the README.md. if you want you to add some images you can add the file to assets\images
  • 7.At the end don't forget to run the test.sh scripts in order to keep the CI success running
  • 8.Commit your update and make a Pull Request

Create issues

Any significant improvement should be documented as a GitHub issue before anybody starts working on it.

Also when filing an issue, make sure to answer these five questions:

  • What operating system and processor architecture are you using?
  • What did you do?
  • What did you expect to see?
  • What did you see instead?