Skip to content

Commit

Permalink
Merge pull request #304 from OpenF2/release/v2.0.0-alpha
Browse files Browse the repository at this point in the history
2.0.0
  • Loading branch information
brianbaker authored Mar 30, 2022
2 parents 6e1e554 + b443784 commit 7071adb
Show file tree
Hide file tree
Showing 470 changed files with 73,953 additions and 220,901 deletions.
19 changes: 19 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"env": {
"browser": true,
"es2021": true
},
"extends": ["eslint:recommended", "prettier"],
"parserOptions": {
"ecmaVersion": 12,
"sourceType": "module"
},
"rules": {
"no-irregular-whitespace": [
"error",
{
"skipComments": true
}
]
}
}
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Auto detect text files and perform LF normalization
* text=auto
* text=auto eol=lf

# Custom for Visual Studio
*.cs diff=csharp
Expand Down
13 changes: 13 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: build
on: [push]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '14'
- run: npm ci
- run: npm run build
- run: npm test
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
docs/dist
dist
.DS_Store
node_modules
*.grunt
Expand All @@ -7,7 +9,6 @@ obj
protos
*.temp
*.nupkg
*.yml
#ignore thumbnails created by windows
Thumbs.db
#Ignore files build by Visual Studio
Expand Down
22 changes: 0 additions & 22 deletions .jshintrc

This file was deleted.

2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist
docs
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ singleQuote: true, tabWidth: 2, trailingComma: none, useTabs: true }
9 changes: 0 additions & 9 deletions .travis.yml

This file was deleted.

48 changes: 22 additions & 26 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Contributing to F2

F2 is currently maintained by [Markit On Demand](http://www.markit.com/Product/Markit-On-Demand) and governed by an [Advisory Board](http://www.openf2.org/#advisory-board) (shown below).

![image](http://www.openf2.org/img/advisory-board.png)
F2 is currently maintained by [IHS Markit Digital](https://www.markitdigital.com/).

Join the team and help contribute to F2 on GitHub. The following are guidelines for contributing; please familiarize yourself before sending pull requests.

Expand All @@ -14,44 +12,43 @@ First, a couple of ground rules.

1. Make sure you have a [GitHub account](https://github.com/signup/free).
2. [Submit a ticket for your issue](https://github.com/OpenF2/F2/issues), assuming one does not already exist. **(Search first!)**
* Clearly describe the issue including steps to reproduce when it is a bug.
* Include the F2 version number.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Include the F2 version number.
3. [Fork the F2 repository](https://github.com/OpenF2/F2/fork).

## New to GitHub?
## New to GitHub?

GitHub has terrific [Guides](http://guides.github.com/) to help developers through various aspects of contributing to open source projects.

## Making Changes

### Understanding the "wip" branch

The latest F2 changes can be found in the `*-wip` branch. This branch's name uses the upcoming version number followed by `-wip` which stands for "work-in-progress", for example `1.3.1-wip` as shown below. There *should* only be one `-wip` branch at any given time.
The latest F2 changes can be found in the `*-wip` branch. This branch's name uses the upcoming version number followed by `-wip` which stands for "work-in-progress", for example `1.3.1-wip` as shown below. There _should_ only be one `-wip` branch at any given time.

Do not work directly in `master`!
Do not work directly in `master`!

![Branches](http://docs.openf2.org/img/branches.png)

### Steps

Once you've forked the F2 repository:

1. Create a new branch in your fork from the next version `*-wip` branch. Do not work directly in `master`!
* `$> git checkout -b 'your_branch_name' *-wip`
3. Read the F2 [coding standards](https://github.com/OpenF2/F2/wiki/Coding-Standards).
4. Add and document unit test(s) for your changes. **At least one unit test is required** for new or changed functionality.
5. Re-run all the Jasmine tests to confirm your changes didn't break anything. `$> grunt test` and/or `$> grunt test-live`
6. Perform browser testing in [supported browsers](https://github.com/OpenF2/F2/wiki/Browser-Compatibility).
1. Create a new branch in your fork from the next version `*-wip` branch. Do not work directly in `master`!
- `$> git checkout -b 'your_branch_name' *-wip`
2. Read the F2 [coding standards](https://github.com/OpenF2/F2/wiki/Coding-Standards).
3. Add and document unit test(s) for your changes. **At least one unit test is required** for new or changed functionality.
4. Re-run all the Jasmine tests to confirm your changes didn't break anything. `$> npm test` and/or `$> npm run test-live`
5. Perform browser testing in [supported browsers](https://github.com/OpenF2/F2/wiki/Browser-Compatibility).

### Committing Changes

* You should only commit files you have changed. **Do not commit compiled or generated F2 files, except:**
* If you've modified any file in the `/sdk/src/` directory, you must commit `/sdk/f2.min.js` for the [Travis unit tests](https://travis-ci.org/OpenF2/F2).
* After you've staged your changes, add a detailed commit message.
* Push committed changes to your fork's branch.
* [Submit a pull request](https://help.github.com/articles/using-pull-requests) for `F2\*-wip` **not** `F2\master`.
* Add a message or additional detail for your changes in the pull request comments.
* Wait for your change(s) to be reviewed.
- You should only commit files you have changed. **Do not commit compiled or generated F2 files**
- After you've staged your changes, add a detailed commit message.
- Push committed changes to your fork's branch.
- [Submit a pull request](https://help.github.com/articles/using-pull-requests) for `F2\*-wip` **not** `F2\master`.
- Add a message or additional detail for your changes in the pull request comments.
- Wait for your change(s) to be reviewed.

## Coding Standards

Expand All @@ -63,11 +60,10 @@ Read our [coding standards](https://github.com/OpenF2/F2/wiki/Coding-Standards).

## Keep in Touch

If you have any questions while writing code to contribute to F2, post a message on the [Google Group](https://groups.google.com/forum/#!forum/OpenF2), find us on Twitter [@OpenF2](https://twitter.com/OpenF2) or by email at [[email protected]](mailto:[email protected]). You can also follow [our blog](http://blog.openf2.org) for more in-depth F2 updates.
If you have any questions while writing code to contribute to F2, post a question on [GitHub Issues](https://github.com/OpenF2/F2/issues/new) or by email at [[email protected]](mailto:[email protected]).

## Resources

* [F2 Google Group](https://groups.google.com/forum/#!forum/OpenF2)
* [F2 Coding Standards](https://github.com/OpenF2/F2/wiki/Coding-Standards)
* [GitHub Documentation: Using Pull Requests](https://help.github.com/articles/using-pull-requests)
* [GitHub Documentation](https://help.github.com/)
- [F2 Coding Standards](https://github.com/OpenF2/F2/wiki/Coding-Standards)
- [GitHub Documentation: Using Pull Requests](https://help.github.com/articles/using-pull-requests)
- [GitHub Documentation](https://help.github.com/)
Binary file added F2-examples.zip
Binary file not shown.
60 changes: 0 additions & 60 deletions F2.latest.js

This file was deleted.

Loading

0 comments on commit 7071adb

Please sign in to comment.