Skip to content
This repository was archived by the owner on Apr 14, 2023. It is now read-only.

Commit

Permalink
Update markdown to refer to finos
Browse files Browse the repository at this point in the history
  • Loading branch information
rstuart-scottlogic committed Jul 4, 2019
1 parent 7d4659e commit 65512ee
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 22 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ that must also be met.**

As a result, PRs submitted to the DataHelix project cannot be accepted until you have a CLA in place with the Foundation.

Notice that some dependencies, as referenced in the [NOTICE](https://github.com/ScottLogic/DataHelix/NOTICE.md) file have certain restrictions upon contributors.
Notice that some dependencies, as referenced in the [NOTICE](https://github.com/finos/datahelix/NOTICE.md) file have certain restrictions upon contributors.

# Contributing Issues

## Prerequisites

* [ ] Have you [searched for duplicates](https://github.com/ScottLogic/DataHelix/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice.
* [ ] Have you [searched for duplicates](https://github.com/finos/datahelix/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice.
* [ ] Are you running the latest version?
* [ ] Are you sure this is a bug or missing capability?

## Raising an Issue
* Create your issue [here](https://github.com/ScottLogic/DataHelix/issues/new).
* Create your issue [here](https://github.com/finos/datahelix/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/)
Expand All @@ -35,12 +35,12 @@ 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/ScottLogic/DataHelix/wiki).
* For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/finos/datahelix/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/ScottLogic/DataHelix/blob/master/NOTICE) with any new attribution or other notices
* If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/finos/datahelix/blob/master/NOTICE) with any new attribution or other notices


## Commit and PR Messages
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.spdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ DataLicense: CC0-1.0
Creator: Scott Logic Ltd
PackageName: DataHelix
PackageOriginator: Scott Logic Ltd
PackageHomePage: https://github.com/ScottLogic/DataHelix
PackageHomePage: https://github.com/finos/datahelix
PackageLicenseDeclared: Apache-2.0
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,7 @@ firstName,age,nationalInsurance
"5ᢃ풞ﺯ䒿囻",57,"RY904705"
[...]
```

**NOTE** we are considering adding a feature that allows you to [specify / restrict the character set](https://github.com/ScottLogic/datahelix/issues/294) in a future release.
**NOTE** we are considering adding a feature that allows you to [specify / restrict the character set](https://github.com/finos/datahelix/issues/294) in a future release.

## Next steps

Expand Down
8 changes: 4 additions & 4 deletions docs/CucumberSyntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ Feature: the name of my feature
| null |
```

More examples can be seen in the [generator cucumber features](https://github.com/ScottLogic/datahelix/tree/master/generator/src/test/java/com/scottlogic/deg/generator/cucumber)
More examples can be seen in the [generator cucumber features](https://github.com/finos/datahelix/tree/master/generator/src/test/java/com/scottlogic/deg/generator/cucumber)

The framework supports setting configuration settings for the generator, defining the profile and describing the expected outcome. All of these are described below, all variable elements (e.g. `{generationStrategy}` are case insensitive), all fields and values **are case sensitive**.

### Configuration options
* _the generation strategy is `{generationStrategy}`_ see [generation strategies](https://github.com/ScottLogic/datahelix/blob/master/generator/docs/GenerationTypes.md) - default: `random`
* _the combination strategy is `{combinationStrategy}`_ see [combination strategies](https://github.com/ScottLogic/datahelix/blob/master/generator/docs/CombinationStrategies.md) - default: `exhaustive`
* _the walker type is `{walkerType}`_ see [walker types](https://github.com/ScottLogic/datahelix/blob/master/generator/docs/TreeWalkerTypes.md) - default: `reductive`
* _the generation strategy is `{generationStrategy}`_ see [generation strategies](https://github.com/finos/datahelix/blob/master/generator/docs/GenerationTypes.md) - default: `random`
* _the combination strategy is `{combinationStrategy}`_ see [combination strategies](https://github.com/finos/datahelix/blob/master/generator/docs/CombinationStrategies.md) - default: `exhaustive`
* _the walker type is `{walkerType}`_ see [walker types](https://github.com/finos/datahelix/blob/master/generator/docs/TreeWalkerTypes.md) - default: `reductive`
* _the data requested is `{generationMode}`_, either `violating` or `validating` - default: `validating`
* _the generator can generate at most `{int}` rows_, ensures that the generator will only emit `int` rows, default: `1000`
* _we do not violate constraint `{operator}`_, prevent this operator from being violated (see **Operators** section below), you can specify this step many times if required
Expand Down
2 changes: 1 addition & 1 deletion generator/docs/DockerSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The instructions below explain how to download the source code, and then build a
Clone the repository to your local development folder.

```
git clone https://github.com/ScottLogic/datahelix.git
git clone https://github.com/finos/datahelix.git
```

## Installation requirements
Expand Down
4 changes: 2 additions & 2 deletions generator/docs/GenerationTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Notes:


## Interesting
See [this document](https://github.com/ScottLogic/datahelix/wiki/Interesting-data-generation) for more details on the _interesting generation mode_.
See [this document](https://github.com/finos/datahelix/wiki/Interesting-data-generation) for more details on the _interesting generation mode_.

The values that are generated by the generator are shown in the matrix below. `granularTo` does not have any bearing on whether the field represents integer or decimal values. If no `ofType` constraint exists then interesting values from _all_ data types can be emitted.

Expand All @@ -30,7 +30,7 @@ The values that are generated by the generator are shown in the matrix below. `g
| **numeric (integer values)** <br /> where all present numeric constraints (if any) contain whole numbers and no decimal points | -100000000000000000000 <br /> 0 <br /> 100000000000000000000 | _A unique set of:_ <br /> the lowest possible value or -100000000000000000000 <br /> 0 (if permitted) <br /> the highest possible value or 100000000000000000000 |
| **numeric (decimal values)** <br /> where some numeric constraints contain a decimal point (even if the fraction is 0, e.g. 10.0) | -100000000000000000000 <br /> 0 <br /> 100000000000000000000 | _A unique set of:_ <br /> the 2 lowest possible values or -100000000000000000000, -99999999999999999999<br /> 0 (if permitted) <br /> the 2 highest possible values or 99999999999999999999, 100000000000000000000 |
| **datetime** | 0000-01-01T00:00:00.000 <br /> 9999-12-31T23:59:59.999 | _A unique set of:_ <br /> the earliest possible date or 0000-01-01T00:00:00.000 <br /> the latest possible date or 9999-12-31T:23:59:59.999 |
| **string** (`aValid ISIN`) | "GB0000000009" <br /> "GB00JJJJJJ45" <br /> "US0000000002" | NA - this constraint has no other constraints that can be used in conjunction with it - see [#488](https://github.com/ScottLogic/datahelix/issues/488) |
| **string** (`aValid ISIN`) | "GB0000000009" <br /> "GB00JJJJJJ45" <br /> "US0000000002" | NA - this constraint has no other constraints that can be used in conjunction with it - see [#488](https://github.com/finos/datahelix/issues/488) |

`null` is considered an interesting value; it will be emitted where permitted (i.e. where there is no `not(is null)` constraint applied to the field)

Expand Down
4 changes: 2 additions & 2 deletions generator/docs/GeneratorSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The instructions below explain how to download the generator source code, build
Clone the repository to your local development folder.

```
git clone https://github.com/ScottLogic/datahelix.git
git clone https://github.com/finos/datahelix.git
```

## Installation Requirements
Expand Down Expand Up @@ -46,7 +46,7 @@ Currently the tests cannot be run from the TestRunner class.

To run a feature file you’ll have to modify the configuration by removing .steps from the end of the Glue field.

An explanation of the particular syntax used can be found [here](https://github.com/ScottLogic/datahelix/blob/master/docs/CucumberSyntax.md).
An explanation of the particular syntax used can be found [here](https://github.com/finos/datahelix/blob/master/docs/CucumberSyntax.md).

## First time setup

Expand Down
2 changes: 1 addition & 1 deletion generator/docs/StringGeneration.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Due to the way that the generator computes textual data internally the generatio

## Anchors

dk.brics.automaton doesn't support start and end anchors `^` & `$` and instead matches the entire word as if the anchors were always present. For some of our use cases though it may be that we want to match the regex in the middle of a string somewhere, so we have two versions of the regex constraint - [matchingRegex](https://github.com/ScottLogic/datahelix/blob/master/docs/ProfileDeveloperGuide.md#predicate-matchingregex) and [containingRegex](https://github.com/ScottLogic/datahelix/blob/master/docs/ProfileDeveloperGuide.md#predicate-containingregex). If `containingRegex` is used then we simply add a `.*` to the start and end of the regex before passing it into the automaton. Any `^` or `$` characters passed at the start or end of the string respectively are removed, as the automaton will treat them as literal characters.
dk.brics.automaton doesn't support start and end anchors `^` & `$` and instead matches the entire word as if the anchors were always present. For some of our use cases though it may be that we want to match the regex in the middle of a string somewhere, so we have two versions of the regex constraint - [matchingRegex](https://github.com/finos/datahelix/blob/master/docs/ProfileDeveloperGuide.md#predicate-matchingregex) and [containingRegex](https://github.com/finos/datahelix/blob/master/docs/ProfileDeveloperGuide.md#predicate-containingregex). If `containingRegex` is used then we simply add a `.*` to the start and end of the regex before passing it into the automaton. Any `^` or `$` characters passed at the start or end of the string respectively are removed, as the automaton will treat them as literal characters.

## Automaton data types
The automaton represents the state machine using the following types:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ private static Map<String, String> instantiatePredefinedCharacterClasses() {
* Get the longest string possible given the regex (in the form of the Automaton)
* There may be many optional sections within a regex which need to be inspected to calculate the longest possible
* string. The automaton has done the hard work of turning the regex into a set of transitions and states.
* see https://github.com/ScottLogic/datahelix/blob/master/generator/docs/StringGeneration.md for more detail.
* see https://github.com/finos/datahelix/blob/master/generator/docs/StringGeneration.md for more detail.
*
* This method is a recursive implementation that will test each starting point calculating the string and returning
* the longest possible variant.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
*
* Crucially, it should never permit an invalid case.
*
* see {@link https://github.com/ScottLogic/datahelix/issues/767 #767} for more details
* see {@link https://github.com/finos/datahelix/issues/767 #767} for more details
*/
public class TypingRequiredPerFieldValidator implements ProfileValidator {
private final DecisionTreeFactory decisionTreeFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
/**
* This class holds the visualisation specific command line options.
*
* @see <a href="https://github.com/ScottLogic/datahelix/blob/master/docs/Options/VisualiseOptions.md">
* @see <a href="https://github.com/finos/datahelix/blob/master/docs/Options/VisualiseOptions.md">
* Visualise options</a> for more details.
*/
@CommandLine.Command(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ private void validateProfile(InputStream schemaStream, InputStream profileStream
"Error(s) occurred during schema validation." +
"\nFile path: " + profilePath.toString() +
"\nFor full details try opening the profile in a json schema-enabled IDE." +
"\nSee https://github.com/ScottLogic/datahelix/blob/master/docs/ProfileDeveloperGuide.md#Microsoft-Visual-Studio-Code\n");
"\nSee https://github.com/finos/datahelix/blob/master/docs/ProfileDeveloperGuide.md#Microsoft-Visual-Studio-Code\n");

throw new ValidationException(errorMessages);
}
Expand Down

0 comments on commit 65512ee

Please sign in to comment.