diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..dbf6af30f2 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing to Waltz +Thanks for your interest in the project! Here is some basic information about how to contribute. + +## Contributor License Agreement (CLA) +A CLA is a document that specifies how a project is allowed to use your +contribution; they are commonly used in many open source projects. + +**_All_ contributions to _all_ projects hosted by [FINOS](https://www.finos.org/) +must be made with a +[Foundation CLA](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/83034172/Contribute) +in place, and there are [additional legal requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Legal+Requirements) +that must also be met.** + +Commits and pull requests to FINOS repositories such as Waltz will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS ["CLA Bot" tool](https://github.com/finos/cla-bot). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. + +As a result, PRs submitted to the Waltz project cannot be accepted until you have a CLA in place with the Foundation. + +Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org?subject=CLA) + +## Raising an Issue +* Create your issue [here](https://github.com/finos/Waltz/issues/new). +* New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, **then delete the other**. + * Please also tag the new issue with either "Bug" or "Enhancement". +* Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/) +liberally to assist in readability. + * [Code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for exception stack traces and log entries, for example, massively improve readability. + +## Contributing Pull Requests (Code & Docs) +To make review of PRs easier, please: + + * Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted. + * For code contributions, follow the existing code layout. + * For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/{program name}/Waltz/wiki). + * Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too). + * Reference issue #s if your PR has anything to do with an issue (even if it doesn't address it). + * Minimise non-functional changes (e.g. whitespace). + * Ensure all new files include a header comment block containing the [Apache License v2.0 and your copyright information](http://www.apache.org/licenses/LICENSE-2.0#apply). + * If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/finos/Waltz/blob/master/NOTICE) with any new attribution or other notices \ No newline at end of file diff --git a/.gitignore b/.gitignore index bd12074c8a..2ed2744383 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,7 @@ dist *.ids npm-debug.log *.log +.settings +*/.classpath +*/.factorypath +**/.project diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index dd241165c1..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,26 +0,0 @@ -# Contributing to Waltz -Thanks for your interest in the project! Here is some basic information about how to contribute. - -# Contributor License Agreement (CLA) -All contributions to [Waltz Open Source](http://www.waltz-technology.com/) projects must be made under a [Contributor License Agreement](https://github.com/khartec/waltz/blob/master/ccla.pdf) that authorizes the project to distribute your code under the APL v2 License. - -Pull requests (PRs) submitted to the project cannot be accepted until you have a CLA in place with the project. - -# Contributing Issues - -## Raising an Issue -* Please raise issues either directly in Github or via the project mailing list (waltz-dev@googlegroups.com) -* Please also tag the new issue with either "Bug" or "Enhancement". - -# Contributing Pull Requests (Code & Docs) -To make review of PRs easier, please: - - * For major enhancements before working on any PR, please review the proposal with the project group via mailing list or via the Github issue to align it with roadmap. - * Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted. - * For code contributions, follow the general structure of the existing code. - * For documentation contributions, follow the general structure, language, and tone of the existing docs. - * Keep PRs small and cohesive - if you have multiple contributions, please submit them as independent PRs. - * Minimize non-functional changes (e.g. whitespace shenanigans). - * Ensure all new files include a header comment block containing the [license and your copyright information](https://github.com/khartec/waltz/blob/master/NOTICE.md). - - diff --git a/NOTICE.md b/NOTICE.md index 9f2b8cc417..5a29ebe23f 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -1,3 +1,9 @@ +Waltz - Enterprise Architecture - FINOS + +Copyright (C) 2019 Waltz open source project + +This product includes software developed at the Fintech Open Source Foundation (https://www.finos.org/). + The following notice should appear in source files: ``` diff --git a/README.md b/README.md index e3d6b57aaa..28da626206 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ NatWest Markets | [press release](https://www.nwm.com/about-us/media/articles/na - Spark framework - JDBC via JOOQ -See [pom.xml](https://github.com/khartec/waltz/blob/master/pom.xml) for a full list of Java dependencies. +See [pom.xml](https://github.com/finos/waltz/blob/master/pom.xml) for a full list of Java dependencies. ### Supported Databases @@ -54,12 +54,24 @@ See [pom.xml](https://github.com/khartec/waltz/blob/master/pom.xml) for a full l - Bootstrap 3 - D3 -See [package.json](https://github.com/khartec/waltz/blob/master/waltz-ng/package.json) for full list of javascript dependencies. +See [package.json](https://github.com/finos/waltz/blob/master/waltz-ng/package.json) for full list of javascript dependencies. -## Contact +## Roadmap -- email: [mailto:dwatkins@khartec.com] +Checkout [the project milestones](https://github.com/finos/waltz/milestones) and browse through the Todo, work in progress and done issues. +## Contributing + +1. Fork it () +2. Create your feature branch (`git checkout -b feature/fooBar`) +3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct) +4. Commit your changes (`git commit -am 'Add some fooBar'`) +5. Push to the branch (`git push origin feature/fooBar`) +6. Create a new Pull Request + +_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. + +*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)* ## Contributors @@ -70,3 +82,11 @@ Individual and organisational contributors are listed in [the contributors file] ## External Resources [Using ArchUnit to formalize architecture rules in the Waltz codebase](https://medium.com/@davidwatkins73/using-archunit-to-formalize-architecture-rules-in-the-waltz-code-base-5fd3e092fc22) + +## License + +Copyright (C) 2019 Waltz open source project + +Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). + +SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0) diff --git a/docs/faq.md b/docs/faq.md index 2f0d997f72..12224b67bf 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -56,14 +56,14 @@ Security **What is covered by the security concept ?** e.g. access-rights, roles, single-feature protection -Waltz implements a basic [role](https://github.com/khartec/waltz/blob/master/waltz-ng/client/user/roles.js) +Waltz implements a basic [role](https://github.com/finos/waltz/blob/master/waltz-ng/client/user/roles.js) based security model. **Is there single-sign-on supported (SAML)?** SAML is not directly supported. However Waltz can be configured with a pluggable -security authentication layer as described in the [settings](https://github.com/khartec/waltz/blob/master/docs/features/configuration/settings.md#security) +security authentication layer as described in the [settings](https://github.com/finos/waltz/blob/master/docs/features/configuration/settings.md#security) documentation. @@ -78,17 +78,17 @@ Non-Functionals **How does the meta-model look like?** The Waltz meta model is described in the -[documentation](https://github.com/khartec/waltz/blob/master/docs/features/README.md) +[documentation](https://github.com/finos/waltz/blob/master/docs/features/README.md) **Which life-cycles for (which) objects are available, e.g. applications?** There is a basic lifecycle -(see the enum [EntityLifecycleStatus](https://github.com/khartec/waltz/blob/master/waltz-model/src/main/java/com/khartec/waltz/model/EntityLifecycleStatus.java)) +(see the enum [EntityLifecycleStatus](https://github.com/finos/waltz/blob/master/waltz-model/src/main/java/com/khartec/waltz/model/EntityLifecycleStatus.java)) supported by the main entities within Waltz. In addition some other classes of entities (e.g. Scenarios and Physical Specifications) -support and enhanced [ReleaseLifecycleStatus](https://github.com/khartec/waltz/blob/master/waltz-model/src/main/java/com/khartec/waltz/model/ReleaseLifecycleStatus.java) +support and enhanced [ReleaseLifecycleStatus](https://github.com/finos/waltz/blob/master/waltz-model/src/main/java/com/khartec/waltz/model/ReleaseLifecycleStatus.java) which operates independently of the entity lifecycle. diff --git a/docs/integration/azure/azure.md b/docs/integration/azure/azure.md index 6608ac108a..4b6aee9792 100644 --- a/docs/integration/azure/azure.md +++ b/docs/integration/azure/azure.md @@ -47,7 +47,7 @@ This may be obtained from the SQL Server options menu, (`Settings > Connection S ### Setting up the schema If you wish to setup the schema you will need to run liquibase as described in the -document: [Liquibase setup](https://github.com/khartec/waltz/blob/master/waltz-data/src/main/ddl/liquibase/README.md) +document: [Liquibase setup](https://github.com/finos/waltz/blob/master/waltz-data/src/main/ddl/liquibase/README.md) ### Data diff --git a/pom.xml b/pom.xml index 171c109dcf..c0d0b2714a 100644 --- a/pom.xml +++ b/pom.xml @@ -41,7 +41,7 @@ http://khartec.com - https://github.com/khartec/waltz/issues + https://github.com/finos/waltz/issues GitHub Issues @@ -55,8 +55,8 @@ - https://github.com/khartec/waltz - scm:git:git://github.com/khartec/waltz.git + https://github.com/finos/waltz + scm:git:git://github.com/finos/waltz.git scm:git:git@github.com:davidwatkins73/waltz.git