Skip to content

Latest commit

 

History

History
81 lines (49 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

81 lines (49 loc) · 2.38 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/AdRoll/rebar3_hank/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting (OTP version, rebar3 version, sample code, etc).
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

rebar3_hank could always use more documentation, whether as part of the official rebar3_hank docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to start a dicsussion at https://github.com/AdRoll/rebar3_hank/discussions.

Get Started!

Ready to contribute? Here's how to set up rebar3_hank for local development.

  1. Fork the rebar3_hank repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/rebar3_hank.git

  3. Compile the project, assuming you rebar3 and OTP 21+ installed, you can run:

    $ rebar3 compile

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass the tests by running rebar3 test. You might have to run it twice, if the dialyzer step fails while building the PLT. It's a known annoyance, sorry about that.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated.
  3. rebar3 test shouldn't fail.