Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 7.52 KB

CONTRIBUTING.md

File metadata and controls

107 lines (76 loc) · 7.52 KB
Raw

Introduction

Welcome to Botpress!

First off, thank you for considering contributing to Botpress

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Botpress is an open source project and we welcome any contributions from our community! There are more ways to contribute that just fixing bugs and writing features - improving the documentation, submitting bug reports and writing tutorials are all great contributions and will be welcomed as much as any other.

However as a reminder we do have a Slack channel and a website so please use these as places to find support rather than using the issue tracker which should be reserved for feature requests and bug reports.

Ground Rules

As contributors you should be respectful and considerate of others - both contributors and non-contributors alike. Please refer to the code of conduct for our and your responsibilities to the rest of the community.

Your Responsibilities

  • Ensure contributions are unit tested and that all tests pass before submitting any pull-request

    To run the tests run

    npm run test

    at a command prompt

  • Ensure that the code lints cleanly

    To lint the code run

    npm run lint

    at a command prompt

  • If you do find any issues or think of a feature please create a Github issue for this first. Discuss things transparently and get community feedback.

Your First Contribution

If you're not sure where to start issues we've labelled some issues with #for-new-contributors so these are a great place to start!

There's an #introduce-yourself channel on our Slack channel so maybe 👋 here and get settled in! We might even 👋 back!

Start by checking out the README and check out the introductory videos and get familiar with what Botpress does.

If you do decide to work on an issue comment saying you intend to pick it up and we'll assign it to you. If you decide it's too much however do tell us and we can try to help out or unassign it so it's free for someone else to pick up.

New to contributing to open-source?

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge. Git can be confusing at times, but essentially this means the project history ends up being cleaner - there's an overview of why we might ask you to rebase here.

Getting started

Contributions to Botpress will be dual-licensed under AGPLv3 and the Botpress Proprietary License. This means that all contributors need to agree to the dual-license before their contributions can be accepted. This is an automatic process when creating the pull-request.

How to report a bug

When filing an issue, make sure to answer these five questions:

  1. What version of Botpress are you using?
  2. What did you do?
  3. What did you expect to see?
  4. What did you see instead?
  5. Any extra detail that might be useful (platform, node version, plugins etc)

Submitting Feature Requests

If you find yourself wishing for a feature that doesn't exist in Botpress, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Botpress has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

However as Botpress has a great module system consider whether the feature you're requesting would be better as a module, rather than expanding the core platform.

Commits & Commit Messages

Try to keep the commit message short. Use the notes section if there is any extra detail you want to convey, and keep commits and pull-requests as focussed as possible.

Reviewing of pull-requests

Pull requests are reviewed as and when the maintainers have the time, however we may have feedback. Try not to take this as a personal criticism but just an attempt to maintain the quality of the project.

Community

The maintainers can be found on Slack and will try to reply to most messages.

Setting up Your Local Dev Environment

If you are interested in contributing to Botpress, you will need to create a local development environment. These instructions were tested on OSX using iTerm for CLI.

These instructions assume a parent directory bar and we will be adding two child directories: botpress and foobot.

  1. Fork the botpress repo & copy the link. (If you are new to open source, GitHub, or Git, check out the excellent egghead.io link in 'New to contributing to open-source?' for additional important Git commands, such as checking out a branch, setting your upstream repo, keeping your local copy in sync, and making your pull request).
  2. In your CLI, create and navigate to the bar directory: $ mkdir bar && cd bar
  3. Clone the forked repo locally. bar $ git clone https://github.com/YOURNAME/botpress.git
  4. Navigate into your local botpress folder bar $ cd botpress

Yarn (recommended) 6. Install the dependencies bar/botpress $ yarn install 7. Compile and run the botpress server bar/botpress $ yarn run watch 8. Open a new terminal/CLI tab 9. From the botpress directory, run bar/botpress $ yarn link 10. Now navigate back to the bar parent directory and create foobot our test bot bar $ ./botpress/bin/botpress init foobot, then entering the project information at the prompts. 11. Navigate into the foobot directory bar $ cd foobot 12. We have to link foobot to our local copy of botpress bar/foobot $ yarn link botpress 13. You can fire up the bot normally with bar/foobot $ bp start

You will note that if you want to access the CLI while botpress and foobot are running, you will need to open a third tab.

NPM 6. Install the dependencies bar/botpress $ npm install 7. Compile and run the botpress server bar/botpress $ npm run watch 8. Open a new terminal/CLI tab 9. From the botpress directory, run bar/botpress $ npm link 10. Now navigate back to the bar parent directory and create foobot our test bot bar $ ./botpress/bin/botpress init foobot, then entering the project information at the prompts. 11. Navigate into the foobot directory bar $ cd foobot 12. We have to link foobot to our local copy of botpress bar/foobot $ npm link botpress 13. You can fire up the bot normally with bar/foobot $ bp start

If you want to confirm that your local copy is working, a straightforward method is to make a change to botpress's React code on your local copy, restart both botpress and foobot ($ yarn run watch / $ npm run watch and $ bp start from their directories), and then visit localhost:3000 in a browser to confirm your change was implemented.