Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.89 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to the Workshop Content

Please note that the contents of this workshop (./docs) were carefuly crafted by the GitHub Team, and as such we are currently not open for direct contributions there.

However, if you have ideas on how to improve the Workshop, feel free to open an issue and share your idea with us. We'll happily discuss it with you.

Contributions to the Code

If you'd like to contribute to the codebase by fixing a bug or improving it in any other way, please read the following section.

Contributions to this project are released to the public under the MIT (for Code) and CC BY-SA 4.0 (Workshop Documentation under ./doc).

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Prerequisites for running and testing code

These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.

  1. install NodeJS & NPM through download | through Homebrew
  2. install golangci-lint

Submitting a pull request

If you see a bug or want to improve the code (anything outside the ./docs folder), please follow these steps:

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm install
  3. Make sure the tests pass on your machine: npm run test
  4. Make sure linter passes on your machine: npm run lint
  5. Create a new branch: git checkout -b my-branch-name
  6. Make your change, add tests, and make sure the tests and linter still pass
  7. Push to your fork and submit a pull request
  8. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources