Skip to content

Latest commit

 

History

History
77 lines (44 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

77 lines (44 loc) · 4.54 KB
Raw

Contributing

Paratii is an open source project that welcomes anyone willing to get involved and to build together upon a common vision. Be on the lookout for issues labeled with help wanted, or good 1st issue if you're warming up.

🌱 Community Guidelines

Paratii aims is to disintermediate story-sharing and to provide equal opportunity of access to the world's attention. Communication regarding the project should foster inclusion, constructive debate and collective progress.

  • Have posture, be clear, never offend: no gender/racial abuse or xenophobia will ever be tolerated. Report any abusive behaviour to the project’s maintainers.
  • Listen before talking.
  • Be welcoming: as a principle, anyone should be able to contribute, regardless of previous experience or scope of contribution.

How to Contribute

☝️ Reporting Issues

If you find a bug/inconsistency, proceed by filing an issue in the affected repository:

  • paratii-player/issues - anything related to the media player (this is our application’s main repo).
  • paratii-contracts/issues - issues related to Paratii’s family of core smart contracts.
  • wiki/issues - anything related to general architecture, incentive structures, specs and documentation.

📊 Tests, Miscellaneous

If you see opportunities to improve test coverage, or envision an alternative implementation of some code that may be advantageous, we are eager to hear about it. Being it minimal, please create a PR. If not, open an issue to discuss the approach and gather feedback.

🔧 Bug fixes

  • Report bugs using issues. Label these issues as bug. Issues identified as a bug shall be labeled bug.
  • If you have a fix for a bug, create a fork, make a PR and refer to the issue number.
  • Ideally, you’d include a test that isolates the bug and verifies that it was fixed :)

💡 New Features

To propose things a certain library is capable of accomplishing, describe the envisioned implementation in an issue, and label it enhancement. Issues that fall under this type will be labeled as such.

We'll do our best to look at proposals and engage in discussion as quickly and soundly as possible. It is recommended that you wait for some feedback before spending time/resources writing code for the envisioned implementation.

📜 Documentation and Translation

Documentation can fall behind when things are advancing fast. If you can’t find the documents you are looking for, or could be saved by a translation, fill an issue in wiki/issues and we’ll do our best to help. Voluntary translations are of course more than welcomed.

💫 To make your contribution shine

  • Descriptive commit messages with associated issues referenced by number.
  • Code neatly under styling conventions.
  • Test suite complete and passing.

👾 Start playing

    1. Fork a repository.
    1. Clone the fork to your local machine.
    1. Create a new branch (e.g. issue-6) where to make your changes and commit them (check if tests pass).
    1. Push the branch to the fork (e.g. git push my-handle issue-6).
    1. Open a PR from the new branch to the original fork's master branch.

If your contribution takes the form of mental resources and thought streams solely, it’ll be a honor to receive you on gitter.