-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Now includes CI & Metrics Test Coverage Update deps MySQL engine support
- Loading branch information
1 parent
4b5d41d
commit 77ecd2c
Showing
36 changed files
with
1,071 additions
and
1,153 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 |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| *.db | ||
| var/*.db* | ||
| *~ | ||
| node_modules | ||
| leveldb-store | ||
| npm-debug.log | ||
| package-lock.json |
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,45 @@ | ||
| language: node_js | ||
|
|
||
| node_js: | ||
| - 14 | ||
|
|
||
| services: | ||
| - docker | ||
| - mysql | ||
| - postgresql | ||
| - couchdb | ||
| - sqlite3 | ||
| - redis | ||
| - cassandra | ||
| - elasticsearch | ||
| - rethinkdb | ||
|
|
||
| before_install: | ||
| - mysql -e 'CREATE DATABASE ueberdb;' | ||
| - mysql -e 'CREATE USER "ueberdb"@"localhost" identified by "ueberdb";' | ||
| - mysql -e "ALTER DATABASE ueberdb CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;" | ||
| - mysql -e "grant CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on ueberdb.* to 'ueberdb'@'localhost';" | ||
| - mysql -e "CREATE TABLE \`store\` (\`key\` varchar(100) COLLATE utf8mb4_bin NOT NULL DEFAULT '',\`value\` longtext COLLATE utf8mb4_bin NOT NULL,PRIMARY KEY (\`key\`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;" ueberdb | ||
| # - cp /etc/rethinkdb/default.conf.sample /etc/rethinkdb/instances.d/instance1.conf | ||
|
|
||
| #addons: | ||
| # rethinkdb: '2.3.4' | ||
|
|
||
| # Brings in procedure required for creating large data set | ||
| - mysql ueberdb < test/lib/mysql.sql | ||
| - mysql ueberdb -e 'CALL generate_data();'; | ||
| - psql -c 'create database ueberdb;' -U postgres | ||
| # - psql -c "grant CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on ueberdb.* to 'ueberdb'@'localhost';" -U postgres | ||
|
|
||
| install: | ||
| - "export GIT_HASH=$(git rev-parse --verify --short HEAD)" | ||
|
|
||
| jobs: | ||
| include: | ||
| - name: "Run the Backend tests" | ||
| install: | ||
| - "npm install" | ||
|
|
||
| notifications: | ||
| email: | ||
| - [email protected] |
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 |
|---|---|---|
| @@ -1,53 +1,103 @@ | ||
| # Developer Guidelines | ||
| # Contributor Guidelines | ||
| (Please talk to people on the mailing list before you change this page, see our section on [how to get in touch](https://github.com/ether/etherpad-lite#get-in-touch)) | ||
|
|
||
| Please talk to people on the mailing list before you change this page | ||
| ## Pull requests | ||
|
|
||
| IRC channels: [#etherpad-lite](irc://freenode/#etherpad-lite) ([webchat](webchat.freenode.net?channels=etherpad-lite-dev)), [#etherpad-lite-dev](irc://freenode/#etherpad-lite-dev) ([webchat](webchat.freenode.net?channels=etherpad-lite-dev)) | ||
| * the commit series in the PR should be _linear_ (it **should not contain merge commits**). This is necessary because we want to be able to [bisect](https://en.wikipedia.org/wiki/Bisection_(software_engineering)) bugs easily. Rewrite history/perform a rebase if necessary | ||
| * PRs should be issued against the **develop** branch: we never pull directly into **master** | ||
| * PRs **should not have conflicts** with develop. If there are, please resolve them rebasing and force-pushing | ||
| * when preparing your PR, please make sure that you have included the relevant **changes to the documentation** (preferably with usage examples) | ||
| * contain meaningful and detailed **commit messages** in the form: | ||
| ``` | ||
| submodule: description | ||
| **Our goal is to iterate in small steps. Release often, release early. Evolution instead of a revolution** | ||
| longer description of the change you have made, eventually mentioning the | ||
| number of the issue that is being fixed, in the form: Fixes #someIssueNumber | ||
| ``` | ||
| * if the PR is a **bug fix**: | ||
| * the first commit in the series must be a test that shows the failure | ||
| * subsequent commits will fix the bug and make the test pass | ||
| * the final commit message should include the text `Fixes: #xxx` to link it to its bug report | ||
| * think about stability: code has to be backwards compatible as much as possible. Always **assume your code will be run with an older version of the DB/config file** | ||
| * if you want to remove a feature, **deprecate it instead**: | ||
| * write an issue with your deprecation plan | ||
| * output a `WARN` in the log informing that the feature is going to be removed | ||
| * remove the feature in the next version | ||
| * if you want to add a new feature, put it under a **feature flag**: | ||
| * once the new feature has reached a minimal level of stability, do a PR for it, so it can be integrated early | ||
| * expose a mechanism for enabling/disabling the feature | ||
| * the new feature should be **disabled** by default. With the feature disabled, the code path should be exactly the same as before your contribution. This is a __necessary condition__ for early integration | ||
| * think of the PR not as something that __you wrote__, but as something that __someone else is going to read__. The commit series in the PR should tell a novice developer the story of your thoughts when developing it | ||
|
|
||
| ## General goals of UeberDB | ||
| * easy to install for admins | ||
| * easy to use for people | ||
| * using less resources on server side | ||
| * easy to embed for admins | ||
| * also runable as UeberDB only | ||
| * keep it maintainable, we don't wanna end ob as the monster UeberDB was | ||
| * extensible, as much functionality should be extendable with plugins so changes don't have to be done in core | ||
| ## How to write a bug report | ||
|
|
||
| ## How to code: | ||
| * **Please write comments**. I don't mean you have to comment every line and every loop. I just mean, if you do anything thats a bit complex or a bit weird, please leave a comment. It's easy to do that if you do while you're writing the code. Keep in mind that you will probably leave the project at some point and that other people will read your code. Undocumented huge amounts of code are worthless | ||
| * Never ever use tabs | ||
| * Indentation: 2 spaces; | ||
| * Don't overengineer. Don't try to solve any possible problem in one step. Try to solve problems as easy as possible and improve the solution over time | ||
| * Do generalize sooner or later - if an old solution hacked together according to the above point, poses more problems than it solves today, reengineer it, with the lessons learned taken into account. | ||
| * Keep it compatible to API-Clients/older DBs/configurations. Don't make incompatible changes the protocol/database format without good reasons | ||
|
|
||
| ## How to work with git | ||
| * Make a new branch for every feature you're working on. Don't work in your master branch. This ensures that you can work you can do lot of small pull requests instead of one big one with complete different features | ||
| * Don't use the online edit function of github. This only creates ugly and not working commits | ||
| * Test before you push. Sounds easy, it isn't | ||
| * Try to make clean commits that are easy readable | ||
| * Don't check in stuff that gets generated during build or runtime (like jquery, minified files, dbs etc...) | ||
| * Make pull requests from your feature branch to our develop branch once your feature is ready | ||
| * Please be polite, we all are humans and problems can occur. | ||
| * Please add as much information as possible, for example | ||
| * client os(s) and version(s) | ||
| * browser(s) and version(s), is the problem reproducible on different clients | ||
| * special environments like firewalls or antivirus | ||
| * host os and version | ||
| * npm and nodejs version | ||
| * Logfiles if available | ||
| * steps to reproduce | ||
| * what you expected to happen | ||
| * what actually happened | ||
| * Please format logfiles and code examples with markdown see github Markdown help below the issue textarea for more information. | ||
|
|
||
| ## General goals of UeberDB | ||
| To make sure everybody is going in the same direction: | ||
| * easy to install for admins and easy to use for people | ||
| * easy to integrate into other apps, but also usable as standalone | ||
| * lightweight and scalable | ||
| * extensible, as much functionality should be extendable with plugins so changes don't have to be done in core. | ||
|
|
||
| ## How to work with git? | ||
| * Don't work in your master branch. | ||
| * Make a new branch for every feature you're working on. (This ensures that you can work you can do lots of small, independent pull requests instead of one big one with complete different features) | ||
| * Don't use the online edit function of github (this only creates ugly and not working commits!) | ||
| * Try to make clean commits that are easy readable (including descriptive commit messages!) | ||
| * Test before you push. Sounds easy, it isn't! | ||
| * Don't check in stuff that gets generated during build or runtime | ||
| * Make small pull requests that are easy to review but make sure they do add value by themselves / individually | ||
|
|
||
| ## Branching model in UeberDB | ||
| ## Coding style | ||
| * Do write comments. (You don't have to comment every line, but if you come up with something that's a bit complex/weird, just leave a comment. Bear in mind that you will probably leave the project at some point and that other people will read your code. Undocumented huge amounts of code are worthless!) | ||
| * Never ever use tabs | ||
| * Indentation: JS/CSS: 2 spaces; HTML: 4 spaces | ||
| * Don't overengineer. Don't try to solve any possible problem in one step, but try to solve problems as easy as possible and improve the solution over time! | ||
| * Do generalize sooner or later! (if an old solution, quickly hacked together, poses more problems than it solves today, refactor it!) | ||
| * Keep it compatible. Do not introduce changes to the public API, db schema or configurations too lightly. Don't make incompatible changes without good reasons! | ||
| * If you do make changes, document them! (see below) | ||
| * Use protocol independent urls "//" | ||
|
|
||
| ## Branching model / git workflow | ||
| see git flow http://nvie.com/posts/a-successful-git-branching-model/ | ||
|
|
||
| * master, the stable. This is the branch everyone should use for production stuff | ||
| * develop, everything that is READY to go into master at some point in time. This stuff is tested and ready to go out | ||
| * release branches, stuff that should go into master very soon, only bugfixes go into these (see http://nvie.com/posts/a-successful-git-branching-model/ for why) | ||
| * you can set tags in the master branch, there is no real need for release branches imho | ||
| * The latest tag is not what is shown in github by default. Doing a clone of master should give you latest stable, not what is gonna be latest stable in a week, also, we should not be blocking new features to develop, just because we feel that we should be releasing it to master soon. This is the situation that release branches solve/handle. | ||
| * hotfix branches, fixes for bugs in master | ||
| * feature branches (in your own repos), these are the branches where you develop your features in. If its ready to go out, it will be merged into develop | ||
| ### `master` branch | ||
| * the stable | ||
| * This is the branch everyone should use for production stuff | ||
|
|
||
| ### feature branches (in your own repos) | ||
| * these are the branches where you develop your features in | ||
| * If it's ready to go out, it will be merged into develop | ||
|
|
||
| Over the time we pull features from feature branches into the develop branch. Every month we pull from develop into master. Bugs in master get fixed in hotfix branches. These branches will get merged into master AND develop. There should never be commits in master that aren't in develop | ||
|
|
||
| ## Documentation | ||
| The docs are in the `doc/` folder in the git repository, so people can easily find the suitable docs for the current git revision. | ||
| ## Testing | ||
| Front-end tests are found in the `tests/frontend/` folder in the repository. Run them by pointing your browser to `<yourdomainhere>/tests/frontend`. | ||
|
|
||
| Back-end tests can be run via `npm test`. | ||
|
|
||
| Documentation should be kept up-to-date. This means, whenever you add a new API method, add a new hook or change the database model, pack the relevant changes to the docs in the same pull request. | ||
| ## Things you can help with | ||
| The Etherpad Foundation is much more than software. So if you aren't a developer then worry not, there is still a LOT you can do! A big part of what we do is community engagement. You can help in the following ways | ||
| * Triage bugs (applying labels) and confirming their existence | ||
| * Testing fixes (simply applying them and seeing if it fixes your issue or not) - Some git experience required | ||
| * Notifying large site admins of new releases | ||
| * Writing Changelogs for releases | ||
| * Creating Windows packages | ||
| * Creating releases | ||
| * Bumping dependencies periodically and checking they don't break anything | ||
| * Write proposals for grants | ||
| * Co-Author and Publish CVEs | ||
| * Work with SFC to maintain legal side of project | ||
|
|
||
| You can build the docs e.g. produce html, using `make docs`. At some point in the future we will provide an online documentation. The current documentation in the github wiki should always reflect the state of `master` (!), since there are no docs in master, yet. |
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
Oops, something went wrong.