Skip to content

Files

Latest commit

 

History

History
130 lines (90 loc) · 4.93 KB

CONTRIBUTING.md

File metadata and controls

130 lines (90 loc) · 4.93 KB

Contributing to CONNECTIVE

First off, its so cool of you to contribute to CONNECTIVE. We can definitely use more hands on this project, and more voices always leads to better results.

Here are guidelines on how to contribute based on what kind of contribution you are thinking of. Please be sure to check out the code of conduct as well.


I have feedback

We would love to here it! You can discuss your feedback here.


I found a bug ...

... and want to report it

  1. Search in the issues section to ensure it is not already reported. If in doubt, you could also simply ask.
  2. Create an issue using this template.
  3. If possible, it would be really helpful if you could:
    1. Create an accompanying pull-request, containing a failing test, or ...
    2. Create an independently executable snippet, like on stackblitz, and share it

... and want to fix it

  1. Search in the issues section to ensure it is not already being worked on. When in doubt, you could simply ask.
  2. Report the issue
  3. Create a pull-request, containing:
    1. A test that would fail without your fix being committed,
    2. Your fix.
    3. Make sure rest of the tests are still passing. If they need to change, explain why.

I have a [feature] suggestion ...

... and want to discuss it

  1. Search in the issues section to ensure it is not already being discussed. If in doubt, you could also simply ask.
  2. Create an issue using this template.
  3. If possible, it would be really helpful if you could:
    1. Create an accompanying pull-request, containing a failing test, or ...
    2. Create an independently executable snippet, like on stackblitz, and share it, or ...
    3. Create a gist explaining the difference between what we have now and what do you want to see.

... and want to implement it

  1. Search in the issues section to ensure it is not already being discussed. If in doubt, you could also simply ask.
  2. Discuss it with the community. Create an issue for it, or just talk with us about it.
  3. Create a pull-request, containing:
    1. A test that would fail without your feature being committed,
    2. Implementation of your feature,
    3. Make sure rest of the tests are still passing. If they need to change, explain why.

I generally want to help

Many thanks! You can:


How to run in development

> git clone https://github.com/CONNECT-platform/connective.git
> cd connective
> npm i

Testing

For CONNECTIVE, tests ARE the specification. They dictate which features the library has and how things behave. Every bug-fix should in the end accompany a test outlining the bug and ensuring that it is being fixed, every feature should in the end accompany a test describing the behavior added by the feature.

You can find the tests in these location:

You can run the tests simply using

> npm test

Documentation

CONNECTIVE's main documentation is accessible here. It is not a specification, as that role is delegated to the tests. It is rather a guide on how to use CONNECTIVE. It outlines the most important elements and how to work with them.

The documentation is written in plain HTML using Nunjucks. The templates rest here.

To build the docs from the templates, simply run this:

> npm run docs

This will not just build the docs, but also serve a local instance on http://localhost:3000. It will also watch for changes to the templates and rebuild.


Current Priorities

These are our current contribution priorities, so if you want to help out, helping with one of these would perhaps be the most helpful: