Contribution Guide

Actively participate in the development and the future of Inkline by contributing regularly.

Open Source projects are maintained and backed by a wonderful community of users and collaborators.

We encourage you to actively participate in the development and future of Inkline by contributing to the source code, improving documentation, reporting potential bugs or testing new features.

Channels

There are many ways to taking part in the Inkline community.

  1. Github Repositories: Report bugs or create feature requests against the dedicated Inkline repository.
  2. Discord: Join the Discord Server to chat instantly with other developers in the Inkline community.
  3. Twitter: Stay in touch with the progress we make and learn about the awesome things happening around Inkline.

Using the issue tracker

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

  • Please do not use the issue tracker for personal support requests.

  • Please do not get off track in issues. Keep the discussion on topic and respect the opinions of others.

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

Bug Reports

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

Guidelines for bug reports:

  1. Provide a clear title and description of the issue.
  2. Share the version of Inkline you are using.
  3. Add code examples to demonstrate the issue. You can also provide a complete repository to reproduce the issue quickly.

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 browser(s) and OS experience the problem?
  • Do other browsers show the bug differently?
  • What would you expect to be the outcome?

All these details will help us fix any potential bugs. Remember, fixing bugs takes time. We're doing our best!

Create a bug report

Feature requests

Feature requests are welcome! When opening a feature request, it's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

When adding a new feature to the framework, make sure you update the documentation package as well.

Testing

Before providing a pull request be sure to test the feature you are adding. Inkline's target code coverage is 100% and we're proudly consistent with that.

Coverage Status

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 starting on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you might spend a lot of time working on something that the project's developers might not want to merge into the project.

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

Do not edit inkline.css, or inkline.js directly! Those files are automatically generated. You should edit the source files in /packages/inkline/src instead.

Similarly, when contributing to Inkline's documentation, you should edit the documentation source files in the /packages/docs directory.

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

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
    git clone https://github.com/<your-username>/inkline.git
    
    # Navigate to the newly cloned directory
    cd inkline
    
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/inkline/inkline.git
    
  2. Create a new topic branch (off the main project master branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>
    
  3. Make sure your commits are logically structured. Please adhere to these git commit message guidelines. Use Git's interactive rebase feature to tidy up your commits before making them public.

  4. Locally rebsase the upstream master branch into your topic branch:

    git pull --rebase upstream master
    
  5. Push your topic branch up to your fork:

    git push origin <topic-branch-name>
    
  6. Open a Pull Request with a clear title and description against the master branch.

Local Development

  1. First, fork the repository and create a branch as specified in the Pull Request Guidelines above.

  2. You'll find a structured lerna project. The folder structure is as follows:

  • packages/inkline contains the UI Framework
  • packages/docs contains the Documentation
  • packages/vue-cli-plugin contains the Vue CLI integration
  • packages/nuxt-module contains the Nuxt integration
  1. Run npm install to install all dependencies. The four child projects dependencies will be automatically installed and linked as well.

  2. To start developing, run npm run dev in your command line to run both inkline and the docs in development mode. The documentation will be automatically linked to the ui framework updates and will react to changes in the framework code.

  3. To test, go to packages/inkline and run npm run test:dev to run the UI Framework tests in development mode. Make sure you run npm run test to run all the tests once (ui framework, docs, integrations) before creating a pull request.

License

By contributing your code, you agree to license your contribution under the MIT License. By contributing to the documentation, you agree to license your contribution under the Creative Commons Attribution 3.0 Unported License.