Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 3.67 KB

Contributing to Weird

Thanks for your help in improving the project!

Contributor License Compromise

Independent contributions (i.e., individual pull requests) from anyone other than the Weird team (Erlend Sogge Heggen and Kapono Haws) are dual-licensed as Polyform NonCommercial (granted to Weird as the licensor) and Blue Oak Model License v1.0.

Thusly all independent contributors retain ownership of their contributions, albeit non-exclusively. In other words, your contributions belong equally to you as to the Weird project.

Furthermore, as a consequence of our Polyform Countdown License Grant, all code releases older than two years are solely licensed as Blue Oak Model License v1.0, i.e. no longer PolyForm NonCommercial licensed.

ℹ️ Questions and Answers

Q&A

What is a "Contributor License Compromise"

It is our alternative to a CLA or DCO. The CLC intends to grant the maintainers of Weird the necessary ownership privileges to run a sustainable project whilst providing a low-friction way for external contributors to submit changes without fully relinquishing ownership of their contributions.

Why the PolyForm NonCommercial license?

Because Weird wants to serve self-hosters and cloud-subscribers on equal terms. As product developers we believe 'you become what you sell', and we want first and foremost to be software providers, not cloud providers. (Expounding blog post TBA).

Why the Blue Oak license?

Blue Oak is a simpler and more modern alternative to older permissive licenses with equivalent legal implications. It is OSI approved

Pull Requests

Even tiny pull requests (e.g., one character pull request fixing a typo in documentation) are greatly appreciated. Before making a large change, it is usually a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged.

Commits

Commit message guidelines

We expect you to use the following format.

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─> Summary. Not capitalized.
  │       │
  │       └─> Commit Scope
  │
  └─> Commit Type: build|ci|docs|feat|fix|perf|refactor|test

The <type> and <summary> fields are mandatory, the (<scope>) field is optional.

<type> must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests

Opening the Pull Request

Before opening a pull request, ensure everything functions correctly locally. You can do this by running just comply followed by just check.