Skip to content

Commit

Permalink
Updating README, NOTICE and other files with new repo URL location
Browse files Browse the repository at this point in the history
  • Loading branch information
maoo committed Mar 5, 2020
1 parent 7e06da5 commit 6f185f3
Show file tree
Hide file tree
Showing 9 changed files with 81 additions and 39 deletions.
File renamed without changes.
38 changes: 38 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 [[email protected]](mailto:[email protected]?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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,7 @@ dist
*.ids
npm-debug.log
*.log
.settings
*/.classpath
*/.factorypath
**/.project
26 changes: 0 additions & 26 deletions CONTRIBUTING.md

This file was deleted.

6 changes: 6 additions & 0 deletions NOTICE.md
Original file line number Diff line number Diff line change
@@ -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:

```
Expand Down
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 (<https://github.com/finos/waltz/fork>)
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 [[email protected]](mailto:[email protected])*

## Contributors

Expand All @@ -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)
10 changes: 5 additions & 5 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand All @@ -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.


Expand Down
2 changes: 1 addition & 1 deletion docs/integration/azure/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<url>http://khartec.com</url>

<issueManagement>
<url>https://github.com/khartec/waltz/issues</url>
<url>https://github.com/finos/waltz/issues</url>
<system>GitHub Issues</system>
</issueManagement>

Expand All @@ -55,8 +55,8 @@
</licenses>

<scm>
<url>https://github.com/khartec/waltz</url>
<connection>scm:git:git://github.com/khartec/waltz.git</connection>
<url>https://github.com/finos/waltz</url>
<connection>scm:git:git://github.com/finos/waltz.git</connection>
<developerConnection>scm:git:[email protected]:davidwatkins73/waltz.git</developerConnection>
</scm>

Expand Down

0 comments on commit 6f185f3

Please sign in to comment.