diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000..3a29a1e4 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,250 @@ +{ + "projectName": "colmena", + "projectOwner": "colmena", + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": true, + "contributors": [ + { + "login": "beeman", + "name": "Bram Borggreve", + "avatar_url": "https://avatars.githubusercontent.com/u/36491?v=3", + "profile": "http://colmena.io/", + "contributions": [ + "question", + "bug", + "code", + "design", + "doc", + "tool" + ] + }, + { + "login": "movibe", + "name": "Willian Ribeiro Angelo", + "avatar_url": "https://avatars.githubusercontent.com/u/1755489?v=3", + "profile": "https://github.com/movibe", + "contributions": [ + "code" + ] + }, + { + "login": "portokallidis", + "name": "Nick Portokallidis", + "avatar_url": "https://avatars.githubusercontent.com/u/977025?v=3", + "profile": "http://nporto.com", + "contributions": [ + "code" + ] + }, + { + "login": "drmikecrowe", + "name": "drmikecrowe", + "avatar_url": "https://avatars.githubusercontent.com/u/90312?v=3", + "profile": "https://github.com/drmikecrowe", + "contributions": [ + "code" + ] + }, + { + "login": "elartix", + "name": "Vladimir Mechkauskas", + "avatar_url": "https://avatars.githubusercontent.com/u/1899626?v=3", + "profile": "http://elartix.com/", + "contributions": [ + "code" + ] + }, + { + "login": "nardoguy14", + "name": "Bernardo Arevalo", + "avatar_url": "https://avatars.githubusercontent.com/u/4164460?v=3", + "profile": "https://github.com/nardoguy14", + "contributions": [ + "code" + ] + }, + { + "login": "yieme", + "name": "yieme", + "avatar_url": "https://avatars.githubusercontent.com/u/8195533?v=3", + "profile": "https://github.com/yieme", + "contributions": [ + "code" + ] + }, + { + "login": "bmcintyre", + "name": "Brian McIntyre", + "avatar_url": "https://avatars.githubusercontent.com/u/339169?v=3", + "profile": "https://github.com/bmcintyre", + "contributions": [ + "code" + ] + }, + { + "login": "rhalff", + "name": "Rob Halff", + "avatar_url": "https://avatars.githubusercontent.com/u/274358?v=3", + "profile": "https://github.com/rhalff", + "contributions": [ + "code" + ] + }, + { + "login": "asgeirbirkis", + "name": "Asgeir Birkisson", + "avatar_url": "https://avatars.githubusercontent.com/u/3543429?v=3", + "profile": "https://github.com/asgeirbirkis", + "contributions": [ + "code" + ] + }, + { + "login": "dthib", + "name": "dthib", + "avatar_url": "https://avatars.githubusercontent.com/u/6855743?v=3", + "profile": "https://github.com/dthib", + "contributions": [ + "code" + ] + }, + { + "login": "flashbag", + "name": "Oleh Kukil", + "avatar_url": "https://avatars.githubusercontent.com/u/3319777?v=3", + "profile": "http://brainstorage.me/flashbag", + "contributions": [ + "code" + ] + }, + { + "login": "pulkitsinghal", + "name": "Pulkit Singhal", + "avatar_url": "https://avatars.githubusercontent.com/u/821963?v=3", + "profile": "http://pulkitsinghal.blogspot.com", + "contributions": [ + "code" + ] + }, + { + "login": "tuanpmt", + "name": "Tuan PM", + "avatar_url": "https://avatars.githubusercontent.com/u/1904924?v=3", + "profile": "http://tuanpm.net", + "contributions": [ + "code" + ] + }, + { + "login": "brownman", + "name": "brownman", + "avatar_url": "https://avatars.githubusercontent.com/u/314539?v=3", + "profile": "http://brownman.github.io", + "contributions": [ + "code" + ] + }, + { + "login": "hoangtrongphuc", + "name": "Hoàng Phúc", + "avatar_url": "https://avatars.githubusercontent.com/u/8570291?v=3", + "profile": "https://github.com/hoangtrongphuc", + "contributions": [ + "code" + ] + }, + { + "login": "bdunnette", + "name": "Brian Dunnette", + "avatar_url": "https://avatars.githubusercontent.com/u/175838?v=3", + "profile": "http://brian.dunnette.us", + "contributions": [ + "code" + ] + }, + { + "login": "Chenzc", + "name": "Chenzc", + "avatar_url": "https://avatars.githubusercontent.com/u/4792828?v=3", + "profile": "https://github.com/Chenzc", + "contributions": [ + "code" + ] + }, + { + "login": "ktersius", + "name": "Tersius Kuhne", + "avatar_url": "https://avatars.githubusercontent.com/u/6417718?v=3", + "profile": "https://github.com/ktersius", + "contributions": [ + "code" + ] + }, + { + "login": "silverbux", + "name": "Alex Quiambao", + "avatar_url": "https://avatars.githubusercontent.com/u/1888261?v=3", + "profile": "https://github.com/silverbux", + "contributions": [ + "code" + ] + }, + { + "login": "josx", + "name": "José Luis Di Biase", + "avatar_url": "https://avatars.githubusercontent.com/u/791137?v=3", + "profile": "http://www.camba.coop", + "contributions": [ + "code" + ] + }, + { + "login": "yshing", + "name": "Shing.", + "avatar_url": "https://avatars.githubusercontent.com/u/5630513?v=3", + "profile": "https://github.com/yshing", + "contributions": [ + "code" + ] + }, + { + "login": "alexthewilde", + "name": "Alex Wilde", + "avatar_url": "https://avatars.githubusercontent.com/u/67973?v=3", + "profile": "alexthewilde.github.io", + "contributions": [ + "code" + ] + }, + { + "login": "dmtw", + "name": "dmtw", + "avatar_url": "https://avatars.githubusercontent.com/u/529030?v=3", + "profile": "https://github.com/dmtw", + "contributions": [ + "code" + ] + }, + { + "login": "kumorig", + "name": "Marcus", + "avatar_url": "https://avatars3.githubusercontent.com/u/5523938?v=3", + "profile": "https://github.com/kumorig", + "contributions": [ + "code" + ] + }, + { + "login": "brannon-darby", + "name": "Brannon N. Darby II", + "avatar_url": "https://avatars2.githubusercontent.com/u/6089253?v=3", + "profile": "https://github.com/brannon-darby", + "contributions": [ + "code" + ] + } + ] +} diff --git a/.bowerrc b/.bowerrc deleted file mode 100644 index 8abee29e..00000000 --- a/.bowerrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "directory": "client/app/bower_components" -} diff --git a/.editorconfig b/.editorconfig index 3cc910d8..3ee22e5d 100644 --- a/.editorconfig +++ b/.editorconfig @@ -11,6 +11,3 @@ end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true - -[*.md] -trim_trailing_whitespace = false diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 00000000..ee440d84 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,3 @@ +node_modules +apps/api/client +apps/admin/dist diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..5234e64a --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,42 @@ + + +### Bug or feature request + + + +- [ ] Bug +- [ ] Feature request + +### Description of feature (or steps to reproduce if bug) + + + +### Link to sample repo to reproduce issue (if bug) + + + +### Expected result + + + +### Actual result (if bug) + + + +### Additional information (OS, Node.js version, etc) + + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..ff528955 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +### Description + + +#### Related issues + + + +- None + +### Checklist + + + +- [ ] New tests added or existing tests modified to cover all changes + + diff --git a/.gitignore b/.gitignore index 6e063594..d3c39acb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,22 +1,5 @@ -.tmp -dist -npm-debug.log +.idea node_modules -downloaded -docular_generated -client/app/js/lb-services.js -client/app/js/config.js -client/app/index.html -.idea/ -storage/ -.strong-pm -.sass-cache -providers.json -bower_components -docs -client/coverage -.vagrant -/.project -.cache -.config -.npm +dist +admin/db.json +lerna-debug.log diff --git a/.jsbeautifyrc b/.jsbeautifyrc deleted file mode 100644 index df468c9e..00000000 --- a/.jsbeautifyrc +++ /dev/null @@ -1,18 +0,0 @@ -{ - "indent_size": 2, - "indent_char": " ", - "indent_level": 0, - "indent_with_tabs": false, - "preserve_newlines": true, - "max_preserve_newlines": 10, - "jslint_happy": false, - "space_after_anon_function": false, - "brace_style": "collapse", - "keep_array_indentation": false, - "keep_function_indentation": false, - "space_before_conditional": true, - "break_chained_methods": false, - "eval_code": false, - "unescape_strings": false, - "wrap_line_length": 120 -} diff --git a/.jshintignore b/.jshintignore deleted file mode 100644 index 6f3a021d..00000000 --- a/.jshintignore +++ /dev/null @@ -1,8 +0,0 @@ -/client/app/scripts/config.js -/client/app/scripts/lb-services.js -/client/app/bower_components/ -/node_modules/ -/Gruntfile.js -/docular_generated/ -/test/ -/dist/ \ No newline at end of file diff --git a/.jshintrc b/.jshintrc deleted file mode 100644 index 40377ba2..00000000 --- a/.jshintrc +++ /dev/null @@ -1,24 +0,0 @@ -{ - "node": true, - "browser": true, - "esnext": true, - "bitwise": true, - "camelcase": true, - "curly": true, - "eqeqeq": true, - "immed": true, - "indent": 2, - "latedef": true, - "newcap": true, - "noarg": true, - "quotmark": "single", - "regexp": true, - "undef": true, - "unused": true, - "strict": true, - "trailing": true, - "smarttabs": true, - "globals": { - "angular": false - } -} diff --git a/.npmrc b/.npmrc index f53dffdc..cffe8cde 100644 --- a/.npmrc +++ b/.npmrc @@ -1,2 +1 @@ - save-exact=true diff --git a/.travis.yml b/.travis.yml index a80b6e03..ffeb0519 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,21 @@ +notifications: + email: false + slack: colmena-cms:o0Inc1h1waa9OKMvL4GiTbDW language: node_js node_js: - - '0.10' -before_script: - - 'npm install -g bower grunt-cli' - - 'bower install' + - '8' +install: + - npm install -g @angular/cli lerna loopback-cli + - npm install +script: + - npm run build +cache: + directories: + - node_modules +deploy: + - provider: script + skip_cleanup: true + script: ./bin/deploy-to-now.sh + on: + branch: develop + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..188f5e08 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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@colmena.io](mailto:info@colmena.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/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f39487c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,223 @@ +# Contributing to Colmena + +Thanks for your interest in contributing to Colmena. + +As a contributor, here are the guidelines we would like you to follow: + + - [Code of Conduct](#coc) + - [Question or Problem?](#question) + - [Issues and Bugs](#issue) + - [Feature Requests](#feature) + - [Submission Guidelines](#submit) + - [Commit Message Guidelines](#commit) + +## Code of Conduct +Help us keep Colmena open and inclusive. Please read and follow our [Code of Conduct][coc]. + +## Got a Question or Problem? + +Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and +feature requests. You've got much better chances of getting your question answered on [Slack](https://colmena-slack.now.sh/). + +If you have a generic question about Angular or LoopBack or one of the include projects, please refer to those projects to get help. + +## Found a Bug? +If you find a bug in the source code, you can help us by +[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can +[submit a Pull Request](#submit-pr) with a fix. + +## Missing a Feature? +You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub +Repository. If you would like to *implement* a new feature, please submit an issue with +a proposal for your work first, to be sure that we can use it. +Please consider what kind of change it is: + +* For a **Major Feature**, first open an issue and outline your proposal so that it can be +discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, +and help you to craft the change so that it is successfully accepted into the project. +* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). + +## Submission Guidelines + +### Submitting an Issue + +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the +discussion might inform you of workarounds readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. +In order to reproduce bugs we might ask you to provide a minimal reproduction scenario in a fork of this project on +GitHub. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you +with additional questions like: + +- version of Colmena used +- 3rd-party libraries and their versions +- and most importantly - a use-case that fails + +A minimal fork of the project allows us to quickly confirm a bug (or point out coding problem) as well as confirm that +we are fixing the right problem. + +We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix +more bugs. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but +we really need to isolate the problem before we can fix it. + +Unfortunately we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from +you we are going to close an issue that don't have enough info to be reproduced. + +You can file new issues by filling out our [new issue form](https://github.com/colmena/colmena/issues/new). + +### Submitting a Pull Request (PR) +Before you submit your Pull Request (PR) consider the following guidelines: + +* Search [GitHub](https://github.com/colmena/colmena/pulls) for an open or closed PR that relates to your submission. +You don't want to duplicate effort. +* Make your changes in a new git branch: + + ```shell + git checkout -b my-fix-branch master + ``` + +* Commit your changes using a descriptive commit message that follows our + [commit message conventions](#commit). Adherence to these conventions + is necessary because release notes are automatically generated from these messages. + + ```shell + git commit -a + ``` + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + +* Push your branch to GitHub: + + ```shell + git push origin my-fix-branch + ``` + +* In GitHub, send a pull request to `colmena:develop`. +* If we suggest changes then: + * Make the required updates. + * Re-run the Colmena test suites to ensure tests are still passing. + * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): + + ```shell + git rebase master -i + git push -f + ``` + +That's it! Thank you for your contribution! + +#### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes +from the main (upstream) repository: + +* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: + + ```shell + git push origin --delete my-fix-branch + ``` + +* Check out the master branch: + + ```shell + git checkout master -f + ``` + +* Delete the local branch: + + ```shell + git branch -D my-fix-branch + ``` + +* Update your master with the latest upstream version: + + ```shell + git pull --ff upstream master + ``` + +## Commit Message Guidelines + +We have very precise rules over how our git commit messages can be formatted. This leads to **more +readable messages** that are easy to follow when looking through the **project history**. But also, +we use the git commit messages to **generate the Colmena change log**. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +