Skip to content
This repository was archived by the owner on Jul 5, 2024. It is now read-only.

Latest commit

 

History

History
53 lines (37 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 1.65 KB

Contributing

We love contributions from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct.

We expect everyone to follow the code of conduct anywhere in thoughtbot's project codebases, issue trackers, chatrooms, and mailing lists.

Contributing Code

  1. Fork the repo and create a local clone of it on your machine.

    Need help with this step? Check out GitHub's Fork a repo documentation.

  2. The primary template files can be found in the template directory; we'll be working from that directory in the following steps.

  3. From the template directory, run the setup script to set up your machine with the necessary dependencies:

    bin/setup

  4. Make sure the site builds successfully:

    bundle exec middleman build --verbose

  5. Make your change(s), then make sure the site still builds successfully. Follow the style guide.

  6. Mention how your changes affect the project to other developers and users in the CHANGELOG.md file.

  7. Write a good commit message. Push to your fork. Submit a pull request.

Others will give constructive feedback. This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution.