Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (39 loc) · 3.74 KB

CONTRIBUTING.md

File metadata and controls

52 lines (39 loc) · 3.74 KB

How to Contribute

Thank you very much for considering contributing to Project Bifrost! It is people like you that make open-source projects happen. Currently, we are focusing on improving our testnet client. There will be invariably bugs and issues, but you can help regardless of what kind of development experience you have.

Before you begin however, please be sure to read our Contributor License Agreement, as your submission of any code or content to any projects or repositories owned, managed, or controlled by Topl constitutes your understanding of and agreement to the terms therein. Additionally, please read our Contributor Code of Conduct. We want to ensure a healthy and collaborative environment here and will be enforcing these rules.

STOP RIGHT NOW AND READ THE CONTRIBUTOR LICENSE AGREEMENT AND CODE OF CONDUCT

Getting Started

If you just want to talk to us or share thoughts you have regarding the project

If you have played around with the client and found some issues that crashes the client, be sure to submit an Issue

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.

Improving and updating the Wiki is always welcomed. It is probably the easiest way to be involved with open-source development. Everyone will love you forever for doing this.

  • Make sure you have a GitHub account
  • git clone https://github.com/Topl/Project-Bifrost.wiki.git
  • Create a new repository on your github account. Let's call it "Project-Bifrost-Wiki".
  • Remove the original "origin" remote and add your github repo as new "origin" git remote rm origin and git remote add origin git@github.com:<YOUR_USERNAME>/Project-Bifrost-Wiki.git
  • Make your proposed changes locally, then push them to your github account: git push -u origin master (-u origin master only required the first time; afterwards just do git push)
  • Submit a ticket to our Github issue tracker requesting maintainers to review your changes and merge them in. Please be sure to include a link to your repo and describe what you've changed.

Making Changes

  • Fork the repository to your Github account.

    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.

  • Make commits.

  • Make sure you have added the necessary tests for your changes.

  • Run all the tests to assure nothing else was accidentally broken.

  • Check for unnecessary whitespace with git diff --check before committing.

  • Make sure your pull request messages are in the proper format.

    PR for Issue #1234 Make the example in CONTRIBUTING imperative and concrete

Prototype waterfall is so 2000 and late engaging cortado experiential quantitative vs. qualitative
earned media cortado food-truck moleskine co-working. Latte pivot sticky note minimum viable product
convergence responsive engaging prototype co-working cortado pitch deck pair programming. Convergence
minimum viable product co-working workflow waterfall is so 2000 and late viral hacker actionable
insight. Food-truck viral user centered design prototype Steve Jobs piverate driven pair programming
user centered design human-centered design physical computing venture capital workflow.

  • Submit a pull request to this repository.