Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.51 KB

CONTRIBUTE.md

File metadata and controls

57 lines (36 loc) · 2.51 KB

Contributing to Ready-Components

As an open source plugin, contributions are welcome.

Pre-requisites

Following are a set of simple tools that you must know to get started with the contributions :

  1. Git (Get Started with learning git.)
  2. Github (Pull requests, commits and issues) (Get Started with learning github)
  3. A Slack account.

Don't worry if you don't know how to use them you can learn them with the help of given links.

Getting started

Before getting started please make sure you have all the above skills

Perform the following steps to start your contribution to our organization.

  1. Fork this repository.
  2. Now create a branch with name "your-name/feature/<name_of_the_feature>".
  3. Now you can start implementing the feature once done push all the changes to the branch you have created and create a pull request to "review" branch.
  4. Pull request will be reviewed and tested. Once it has been passed your features would be merged with the plugin.

Also if you implement any feature without consulting/informing any of the members your code won't be reviewed and accepted.

Note :

If you have any doubts regarding above steps or you are having any trouble then you can contact 
on slack(link below).

Bug reporting

We appreciate your effort to improve inventory-management by submitting a bug report. Before doing so, please check the following things:

  1. Check whether the bug you face hasn't been already reported. Duplicate reports takes us time, that we could be used to fix other bugs or make improvements.
  2. If you got some error, please describe what happened and add error message. Reports like "I get error when I clicked on some link." are useless. Thanks for your help!

Patches submission

Patches are welcome as pull requests on GitHub. Please include a Signed-off-by tag in the commit message (you can do this by passing --signoff parameter to Git).

When creating the commit on GitHub or using some other tool which does not have direct support for this, it is the same as adding Signed-off-by: Your name <email@example.com> as the last line of the commit message.

Note that by submitting patches with the Signed-off-by tag, you are giving permission to license the patch as GNU Liscense.

More information

If you have any further queries you can contact on slack channel https://ready-components.slack.com/messages/DK86HAM47 . Also you can mail at pixelit.care@gmail.com