Skip to content

Latest commit

 

History

History
232 lines (153 loc) · 10.4 KB

CONTRIBUTING.md

File metadata and controls

232 lines (153 loc) · 10.4 KB
Raw

Contributing

Looking to contribute something to Universe? Here's how you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests, custom issues and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests. Please use the Universe Slack chat app as it is a better places to get help.

  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

  • Please do not post comments consisting solely of "+1" or ":thumbsup:". Use GitHub's "reactions" feature instead. We reserve the right to delete comments which violate this rule.

When reporting a bug, include:

  • Device and device version (Raspberry Pi Zero, Raspberry Pi 2, MacBook Pro etc..)

  • Operating system and version (Mac OS X, Linux, Raspian, etc..)

Bug report

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

› Report bug

Guidelines for bug reports:

  1. validate your HTML to ensure your problem isn't caused by a simple error in your own code.

  2. Use the GitHub issue search — check if the issue has already been reported.

  3. Check if the issue has been fixed — try to reproduce it using the latest master or develop branch in the repository.

  4. Isolate the problem — ideally create a reduced test case and a live example. This JS Bin is a helpful template.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What device and OS are you using when experiencing the problem? Do other environments show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the device/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Feature requests are highly encouraged. We want to hear from you on what you'd like to see and/or how you'd like to utilize or access the Universe node network.

› Request a feature

When submitting a feature request, take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince community members of the merits of this feature. Please provide as much detail and context as possible, providing relevant links, prior art, or live demos whenever possible.

Git-Flow (AVH)

All Universe projects are based off of Vincent Driessen's git-flow branching model for clarity and increased efficiency amongst the project. We highly recommend simplifying the git-flow model by installing and using the git-flow avh git extension.

Although we use the majority of the git flow avh process, we do not use the releases portion of Git Flow unless we are working on multiple releases at one time.

Workflow using Git Flow AVH

The master branch is handled by the repository manager.

develop is the main branch to work off of and is to always remain up to date. When you create a feature using git flow feature start [name], you are creating that feature from the develop branch. When you are done with the feature run git flow feature finish [name] and that will automatically merge your feature back into the develop branch and automatically delete your feature branch for you.

If you're not familiar with git-flow, no worries, just let us know in the #engineering channel of the Universe Slack and someone will happily walk you through the installation and usage of the git extension.

Pull requests

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

NOTE: All pull requests should target the develop git branch, where they will be welcomed and duly considered.

Please adhere to the coding guidelines used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project.

    i. On GitHub, navigate to the universelabs/universe repository.
    ii. In the top-right corner of the page, click Fork.

  2. Clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/universe.git
# Navigate to the newly cloned directory
cd universe
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/universelabs/universe.git

  3. If you cloned a while ago, get the latest changes from upstream:

    git checkout develop
git pull upstream develop

  4. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b pull-request/<topic-branch-name>

  5. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely to be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  6. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream develop

  7. Push your topic branch up to your fork:

    git push origin pull-request/<topic-branch-name>

  8. Open a Pull Request with a clear title and description against the develop branch.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License (if it includes code changes).

Code guidelines

HTML

Adhere to the Code Guide.

  • Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
  • Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via file://.
  • Use WAI-ARIA attributes in documentation examples to promote accessibility.

CSS

Adhere to the Code Guide.

JS

  • No semicolons (in client-side JS)
  • 2 spaces (no tabs)
  • strict mode
  • "Attractive"

Checking coding style

Run npm run test before committing to ensure your changes follow our coding standards.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Universe is maintained under the Semantic Versioning guidelines.

Universe Semantic Versioning Example:

v0.1.0-alpha ‹— Alpha

v0.1.4-alpha ‹— Alpha

v0.2.22-alpha ‹— Alpha

v0.4.0-beta ‹— Beta

v0.5.13-beta ‹— Beta

v1.0.0 ‹— v1

v1.14.3 ‹— v1

v3.2.78 ‹— v3

We use git tags to declare versions and manually create releases. We use Git-Flow (AVH) for branching only.

See the Releases section of our GitHub project for changelogs for each release version of Universe.