Skip to content
This repository has been archived by the owner on Jul 25, 2023. It is now read-only.

Latest commit

 

History

History
19 lines (15 loc) · 851 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) · 851 Bytes

Contributing

This is a quick overview for what you should know when contributing to this Git repository.

  • There is a code style guide in arweave_styleguide.md. Please note that we're using tabs for indentation.
  • To run the tests you need to do two things:
    1. Uncomment out %-define(DEBUG, debug). in src/ar.hrl.
    2. Run make test.
  • You can discuss development and get help from the Arweave organization and community in the #dev channel on our Discord server.

Workflow

  1. Fork the main Git repo https://github.com/ArweaveTeam/arweave.git
  2. Branch out from master.
  3. Add your changes.
  4. Run the tests (see above).
  5. Rebase your branch on the upstream master if the upstream master has moved since you branched out.
  6. Create a PR back to the upstream master.

Happy hacking! :)