Skip to content

Commit

Permalink
fix: spell checking everything
Browse files Browse the repository at this point in the history
completed a full spell check of templates, and exchange readme files
  • Loading branch information
AlexBrad1eyCT committed Jan 17, 2022
1 parent 258d515 commit 440c94a
Show file tree
Hide file tree
Showing 19 changed files with 56 additions and 34 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/dataset_bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ assignees: ''

### **Bug Type**

- [ ] Syntax - invalid ifc syntax or encoding
- [ ] Syntax - invalid Ifc syntax or encoding
- [ ] Usage & Logic - content not representative or invalid against purpose
- [ ] Validiation Criteria - does not satisfy defined criteria
- [ ] Validation Criteria - does not satisfy defined criteria
- [ ] Coverage - does not provide adequate coverage of variations

**Test Case Code**: [MVD_Ex_XXXX](url)


### **Expected content/behaviour**
*A clear and concise description of what the expected behavour or content is.*
*A clear and concise description of what the expected behaviour or content is.*

***Screenshots**
If applicable, add screenshots to help explain your problem.*
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/documentation_bug_report.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Documenation Bug report
name: Documentation Bug report
about: Create a report to help us improve documentation
title: '[Bug Docs]: '
labels: bug, documentation
Expand All @@ -16,8 +16,8 @@ assignees: ''

- [ ] Exchange documentation
- [ ] Test case documentation
- [ ] Test case principles or valdiation criteria
- [ ] Test case datasets documentaiton
- [ ] Test case principles or validation criteria
- [ ] Test case datasets documentation

**Reference Code**: [MVD_Ex_XXXX](url)

Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## Summary

*Outline of the content and tasks addressed by this pull request, dont forget to link the relevent issue(s)*
*Outline of the content and tasks addressed by this pull request, don't forget to link the relevant issue(s)*

## Purpose
Please mark the relevent tasks that this pull request creates or updates:
Please mark the relevant tasks that this pull request creates or updates:

### Exchanges

Expand Down
2 changes: 1 addition & 1 deletion E1-ALRF/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Alignment Reference Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|------------------------------|------------|
| **IFC4x3_AbRV-E1** | ALRF | Alignment Reference Exchange | 2 |

Expand Down
6 changes: 3 additions & 3 deletions E10-MTME/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Maritime Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|-----------------------------|------------|
| **IFC4x3_AbRV-E10** | TECO | Maritime Elements Exchange | XX |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|---------------------|--------------|-----------------------------|------------|
| **IFC4x3_AbRV-E10** | TECO | Maritime Elements Exchange | XX |

Exchange Lead: @AlexBrad1eyCT

Expand Down
10 changes: 5 additions & 5 deletions E1a-ARSE/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Alignment Reference Super Elevation Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|---------------------|--------------|----------------------------------------------|------------|
| **IFC4x3_AbRV-E1a** | ARSE | Alignment Reference Super Elevation Exchange | 2 |

Expand All @@ -20,7 +20,7 @@ TBC

## Test Instructions

| TI Code | Test Instruction Title |
|------------------------------------|----------------------------------|
| [**IFC4x3_AbRV-E1a-ALIN**](./ALIN) | Alignment Infrastructure Curves |
| [**IFC4x3_AbRV-E1a-ALSE**](./ALSE) | Alignment Superelevation & Width |
| TI Code | Test Instruction Title |
|------------------------------------|-----------------------------------|
| [**IFC4x3_AbRV-E1a-ALIN**](./ALIN) | Alignment Infrastructure Curves |
| [**IFC4x3_AbRV-E1a-ALSE**](./ALSE) | Alignment Super Elevation & Width |
2 changes: 1 addition & 1 deletion E1b-ARCT/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Alignment Reference Cant Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|---------------------|--------------|-----------------------------------|------------|
| **IFC4x3_AbRV-E1b** | ALCT | Alignment Reference Cant Exchange | 2 |

Expand Down
2 changes: 1 addition & 1 deletion E2-AGST/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aggregate Structures Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|-------------------------------|------------|
| **IFC4x3_AbRV-E2** | AGST | Aggregate Structures Exchange | 5 |

Expand Down
2 changes: 1 addition & 1 deletion E2a-TRST/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Track Structures Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|---------------------|--------------|---------------------------|------------|
| **IFC4x3_AbRV-E2a** | AGST | Track Structures Exchange | 1 |

Expand Down
2 changes: 1 addition & 1 deletion E3-EWKS/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Earthworks Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|---------------------|------------|
| **IFC4x3_AbRV-E3** | EWKS | Earthworks Exchange | 4 |

Expand Down
2 changes: 1 addition & 1 deletion E4-BRST/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bridge Structural Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|----------------------------|------------|
| **IFC4x3_AbRV-E4** | BRST | Bridge Structural Exchange | XX |

Expand Down
2 changes: 1 addition & 1 deletion E5-SIGN/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Signalling Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|---------------------|------------|
| **IFC4x3_AbRV-E5** | SIGN | Signalling Exchange | XX |

Expand Down
2 changes: 1 addition & 1 deletion E6-ENGY/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Energy Exchange (Railway)

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|---------------------------|------------|
| **IFC4x3_AbRV-E6** | ENGY | Energy Exchange (Railway) | XX |

Expand Down
2 changes: 1 addition & 1 deletion E7-GEOT/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Geotechnics Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|----------------------|------------|
| **IFC4x3_AbRV-E7** | GEOT | Geotechnics Exchange | 5 |

Expand Down
2 changes: 1 addition & 1 deletion E8-TECO/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Telecommunications Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|-----------------------------|------------|
| **IFC4x3_AbRV-E7** | TECO | Telecommunications Exchange | XX |

Expand Down
2 changes: 1 addition & 1 deletion E9-DNGE/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Drainage Exchange

| Exhange Code | Abbreviation | Exchange Name | Test Cases |
| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|--------------------|--------------|-------------------|------------|
| **IFC4x3_AbRV-E8** | TECO | Drainage Exchange | XX |

Expand Down
12 changes: 6 additions & 6 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use the table of contents icon <img src="../assets/images/table-of-contents.png"
## Getting Started
This repository contains the working content for the documentation and certification of the draft Alignment based Reference View (Model View Definition) or AbRV for the reference exchange of infrastructure information.

It also serves as an initial proof of concept for the use of a git repository for the development and dissemination of MVD certification information, with the objective to speed up the development of the certification test cases and content, and provide greater access and readability of the certification critieria content.
It also serves as an initial proof of concept for the use of a git repository for the development and dissemination of MVD certification information, with the objective to speed up the development of the certification test cases and content, and provide greater access and readability of the certification criteria content.

The repository is structured into the following layers breaking down the content in to the MVD exchange definitions and associated Test cases & Test case datasets:

Expand All @@ -18,14 +18,14 @@ The repository is structured into the following layers breaking down the content
- *Readme*: Documentation of the Test case
- **Test Case Dataset**
- *Readme*: Documentation of the test case dataset
- IFC dataset, images, and supplimentary files
- IFC dataset, images, and supplementary files

The content of the readme's and folders is further explained below in the [templates](#templates) section of the guide.

## Issues & Proposals
If you spot an problem or have a proposal for additional content such as exchange definitions or test cases, this should be logged as an issue. Before logging a new issue make sure to [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments), to avoid duplication. If a related issue or proposal doesn't exist, you can open a new issue using a relevent [issue form](https://github.com/bSI-InfraRoom/MVD-Infra-Test-Instructions/issues/new/choose).
If you spot an problem or have a proposal for additional content such as exchange definitions or test cases, this should be logged as an issue. Before logging a new issue make sure to [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments), to avoid duplication. If a related issue or proposal doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/bSI-InfraRoom/MVD-Infra-Test-Instructions/issues/new/choose).

Please label your issues appropriately using the currently defined labels of the repository. Labels are based on the catagory of issue and the effect a solution will have on the content base.
Please label your issues appropriately using the currently defined labels of the repository. Labels are based on the category of issue and the effect a solution will have on the content base.

## Content Contribution
To contribute to the content being developed or solve outstanding issues brought up by the community, this repository uses a Fork & Pull Request workflow to ensure quality and control contribution to the content base.
Expand All @@ -37,7 +37,7 @@ The repository has 2 main branches:
- master: containing primary released content
- develop: completed and/or quality assured content for the next release.

feature branches should be named `feature/xxxx` to destinguish them from other types of branches such as bugfixes or release branches.
feature branches should be named `feature/xxxx` to distinguish them from other types of branches such as bugfixes or release branches.

### Content & Templates
Once a fork and branch has been setup, you are free to develop your content. this should be developed using the templates in the [docs](./) folder for an exchange definition or test case. detailed content of the readme's and folders is further explained below in the [templates](#templates) section of the guide.
Expand All @@ -47,7 +47,7 @@ once the content is complete or is ready to be initially reviewed by the maintai

use the provide pull request template to specify the content being submitted and assign the appropriate labels. Assignees are those developing the pull request (aka you!) and Reviewers will be assigned appropriately based on content.

Make sure to Link the relevent issue to your pull request via the Linked issues interface or key words such as `fixes #XX` in the PR summary. [Information on linking issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
Make sure to Link the relevant issue to your pull request via the Linked issues interface or key words such as `fixes #XX` in the PR summary. [Information on linking issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).


## Templates
Expand Down
22 changes: 22 additions & 0 deletions docs/En-XXXX/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Template Exchange

| Exchange Code | Abbreviation | Exchange Name | Test Cases |
|---------------------|--------------|-----------------------------|------------|
| **IFC4x3_AbRV-En** | XXXX | Template Exchange | XX |

Exchange Lead: @XXX

## Summary

TBC

### Scope

TBC

## Test Instructions

| TI Code | Test Instruction Title |
|------------------------------------|------------------------------------|
| [**IFC4x3_AbRV-E10-XXXX**](./XXXX) | Test Instruction |

2 changes: 1 addition & 1 deletion docs/XXXX/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ For certification of capabilities the only source will be:

- n. 1 IFC file containing the information as requested. The file shall be named using the following syntax: `MVDCode`-`ExchangeCode`-`TestCode`-`SoftwareVendor`.`ifc` (Example: `IFC4.3_AbRV-E2b-ASTPC-AmazingSoft.ifc`)

Considering the aim of this test, other **optional** results, not subject to the bSI certification process, yet usefull to illustrate test results are:
Considering the aim of this test, other **optional** results, not subject to the bSI certification process, yet useful to illustrate test results are:
- Screen-shot of ...
- CSV export of ...

Expand Down

0 comments on commit 440c94a

Please sign in to comment.