Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(ui-admin): disabled licensing in CE
- Loading branch information
Showing
22 changed files
with
1,384 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at `info [AT] botpress.io`. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
# 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](https://slack.botpress.io/) and a [website](https://botpress.io/) 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](./CODE_OF_CONDUCT.md) 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 | ||
|
||
Before you run the tests, you need a PostgreSQL server running on your machine. If you have | ||
[Docker](https://www.docker.com/) installed, you can run the following at the command prompt, | ||
to automatically download and start a PostgreSQL server. You don't need to | ||
understand or install PostgreSQL Server yourself. | ||
|
||
To run local PostgreSQL server at the command prompt. | ||
``` | ||
# MacOS | ||
docker run -p 5432:5432 -e POSTGRES_USER=$USER postgres | ||
# Windows PowerShell | ||
docker run -p 5432:5432 -e POSTGRES_USER=$env:UserName postgres | ||
``` | ||
note: | ||
* Press `CTRL-c` to stop it. | ||
|
||
To run the tests run at the command prompt. | ||
``` | ||
npm run test | ||
``` | ||
|
||
* Ensure that the code lints cleanly | ||
|
||
To lint the code run at the command prompt. | ||
``` | ||
npm run lint | ||
``` | ||
|
||
* If you do find any issues or think of a feature please [create a Github issue](https://help.github.com/articles/creating-an-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](https://github.com/botpress/botpress/issues?q=is%3Aissue+is%3Aopen+label%3Afor-new-contributors) so these are a great place to start! | ||
|
||
There's an *#introduce-yourself* channel on our [Slack channel](https://slack.botpress.io/) so maybe :wave: here and get settled in! We might even :wave: back! | ||
|
||
Start by checking out the [README](./README.md) 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](https://egghead.io/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 :smile_cat: | ||
|
||
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](https://www.atlassian.com/git/tutorials/merging-vs-rebasing). | ||
|
||
# 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](https://slack.botpress.io/) 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](https://github.com/botpress/botpress) & 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. Open a new terminal/CLI tab, and run commands | ||
```shell | ||
# botpress terminal window | ||
|
||
# create and navigate to the `bar` directory | ||
$ mkdir bar && cd bar | ||
# Clone the forked repo locally | ||
bar $ git clone https://github.com/YOURNAME/botpress.git | ||
``` | ||
|
||
3. Continue running commands in the **botpress terminal window** | ||
|
||
```shell | ||
# Install Yarn globally | ||
bar $ npm install --global yarn | ||
|
||
# Navigate to the botpress directory | ||
bar $ cd botpress | ||
|
||
# Setup the dev environment | ||
bar/botpress $ yarn run bootstrap | ||
|
||
# Start the botpress server | ||
bar/botpress $ yarn start | ||
``` | ||
|
||
4. Open a new terminal/CLI tab (**foobot**), and run commands | ||
|
||
```shell | ||
# Create our test bot called `foobot` | ||
bar $ yarn --cwd=botpress run init-foobot | ||
|
||
# Navigate to the foobot directory | ||
bar $ cd foobot | ||
|
||
# Start the bot normally | ||
bar/foobot $ bp start | ||
``` | ||
|
||
*Next Steps* | ||
|
||
5. 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. | ||
6. 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 | ||
- edit code in botpress | ||
- in: **botpress terminal window** | ||
```shell | ||
# Ctl-C to end watch | ||
# Start botpress | ||
bar/botpress $ yarn start | ||
``` | ||
- in: **foobot terminal window** | ||
```shell | ||
# Ctl-C to stop bot | ||
bar/foobot $ bp start | ||
``` | ||
- visit `localhost:3000` in a browser to confirm your change was implemented |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## Give a One-time Donation | ||
|
||
We are using PayPal for contributing, because it's easier for everyone to make a transaction. We plan to use a Bitcoin Wallet in the future for saving on transaction feeds. | ||
|
||
Our PayPal address is : [FILL_PAYPAL_ADDRES] | ||
|
||
|
||
## FAQs on Donating | ||
|
||
### Why Should I Donate ? | ||
|
||
Botpress is free and open source framework. Our mission it's to create the best bot framework. All the donation will directly go on Botpress development. | ||
|
||
If you are interesting to donate for a particular module let us know. We will be very happy to hear your conviction and importance about this module. | ||
|
||
### Is there any receipt or invoice ? | ||
|
||
Yes, you will receive an invoice by PayPal. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
Make sure these checkboxes are checked before raising an issue, thank you! | ||
|
||
- [] Check that you are using node version >= `8.9` | ||
- [] Search the [documentation](https://botpress.io/docs) | ||
- [] Search the [help portal](https://help.botpress.io/) | ||
|
||
Please also fill in these fields: | ||
|
||
--- | ||
|
||
<!-- Run `botpress -V` --> | ||
### Botpress version: `<<VERSION HERE>>` | ||
|
||
<!-- Which channels is your bot using? --> | ||
### Channels: <<list of channels>> |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"hooks": { | ||
"pre-commit": "lint-staged" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
module.exports = { extends: ['@commitlint/config-conventional'] } |
Oops, something went wrong.