chromebrew/CONTRIBUTING.md

Contributing

Are you wondering how you can get started? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.

Prerequisites

1. A GitHub project in which you have access
2. A text editor or IDE (integrated development environment)
3. Basic knowledge of the command line in a terminal session
4. git
5. SSH key

How to submit a Pull Request (aka PR)

1. Click the Fork button in the top right to copy the repo to your own GitHub project.
2. Open a terminal and clone your forked project locally:

$ git clone git@github.com:your-project-name/chromebrew.git && cd chromebrew

3. Create a branch for your PR:

$ git checkout -b update-cool-package

4. Add, edit or delete the file(s) you would like to change and save.
5. Test your changes! See steps 7 through 11 in the How to test a pending PR from another contributor section below.
6. Stage your changes:

$ git add -A

7. Review your changes:

$ git diff --staged

8. Correct your changes and repeat steps 4 through 7, if necessary.
9. Commit your changes:

$ git commit -m "Add some awesome change to cool package"

10. Push your changes:

$ git push origin update-cool-package

11. Visit your project page in the browser: https://github.com/your-project-name/chromebrew
12. Click the New pull request button next to the Branch: selector drop-down.
13. Select your branch name from the compare: selector drop-down on the right.
14. Scroll down and review your changes.
15. Click the Create pull request button.
16. Add a short description of your change.
17. Click the Create pull request button.

How to test a pending PR from another contributor

1. Open the PR of interest.
2. Next to the green Open badge, you should see something similar to:

contributor-name wants to merge 1 commit into chromebrew:master from contributor-name:update-cool-package

3. On the far right, take note of contributor-name:update-cool-package. This is the PR contributor along with the branch they want to merge.
4. Open a terminal, change to your cloned chromebrew directory and execute:

$ git remote add contributor-name git@github.com:contributor-name/chromebrew.git

5. Fetch their branches:

$ git fetch contributor-name

6. Checkout their branch:

$ git checkout update-cool-package

7. If the requested change is a package:

$ cp packages/cool_package.rb /usr/local/lib/crew/packages/

8. Test the new or updated package:

$ crew upgrade cool_package

9. Examine the files to see if everything installed as expected:

$ crew files cool_package

10. Run some tests on executables, if applicable:

$ cool_package --version
$ cool_package --help
$ cool_package --some-other-option

11. To see if this package is a dependency for another package, execute:

$ grep "depends_on 'cool_package'" packages/*.rb

and, just in case:

$ grep 'depends_on "cool_package"' packages/*.rb

If the package is a dependency for another package, test commands of the other package, if possible, to see if they were affected in any way.

12. Visit the PR and add a comment suggesting any changes or mark it RTBC if everything looks good.

Learn more

• Visit the wiki

Pre-commit hooks.

Chromebrew has pre-commit hooks to catch errors before they make it to CI.

To install them, run pre-commit install in the root of the repository.

You will first need to install the pre-commit tool, which can be done via crew install py3_pre_commit on ChromeOS.