Skip to content
This repository has been archived by the owner on Jan 1, 2024. It is now read-only.

Latest commit

 

History

History
31 lines (25 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

31 lines (25 loc) · 1.44 KB

Contributing to packages_bot

First off, thanks for taking the time to contribute!

Now, take a moment to be sure your contributions make sense to everyone else. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Reporting Issues

Found a problem? Want a new feature? First of all see if your issue or idea has already been reported. If don't, just open a new clear and descriptive issue.

Submitting pull requests

Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.

  • Fork it!
  • Clone your fork: git clone https://github.com/<your-username>/packages_bot
  • Navigate to the newly cloned directory: cd packages_bot
  • Create a new branch for the new feature: git checkout -b my-new-feature
  • Install the tools necessary for development: mix deps.get
  • Make your changes.
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request with full remarks documenting your changes.

Running locally

To install and run the bot locally:

  • Clone the repo: git clone https://github.com/thiamsantos/packages_bot
  • Navigate to the newly cloned directory: cd packages_bot
  • Run mix deps.get
  • Run mix phx.server to run the bot