Skip to content

Latest commit

 

History

History
88 lines (56 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

88 lines (56 loc) · 3.41 KB

Contributing to Kenx-node

Thanks for checking out the Kenx-node! We're excited to hear and learn from you. Your experiences will benefit others who read and use these guides.

We've put together the following guidelines to help you figure out where you can best be helpful.

Table of Contents

  1. Types of contributions we're looking for
  2. Ground rules & expectations
  3. How to contribute
  4. Setting up your environment
  5. Community

Types of contributions we're looking for

There are many ways you can directly contribute to Kenx (in descending order of need):

  • Create PR to fix or improve functionalities
  • Extend the frameworks's support by creating more plugins.
  • Participate with instructions, comments and support for others at the issues section.

Interested in contributing to Kenx? Read on!

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • Kenx frameworks are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  • Please ensure that your contribution passes all tests if you open a pull request. If there are test failures, you will need to address them before we can merge your contribution.
  • Please consider contributing things that are widely valuable. Please don't add references or links to things you or your employer have created, as others will do so if they appreciate it.

How to contribute

If you'd like to contribute, start by searching through the pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of the framework, open a pull request.

Setting up your environment

This site is powered by NodeJS. Running it on your local machine requires a working NodeJS installation with NPM or YARN.

Once you have that set up:

  1. Open your favorate terminal pointed to your working directory folder.
cd path/to/folder
  1. Clone this repository using Git commands
git clone https://github.com/ckenx/kenx-node
cd /kenx-node
  1. Install the project dependencies
npm install

or

yarn install
  1. Run the project
npm run dev

or

yarn dev

…and open http://localhost:8008 in your web browser. You can customize the default port by setting PORT in your environment variables

Community

Discussions about Kenx-node take place on this repository's Issues and Pull Requests sections. Anybody is welcome to join these conversations.

Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.