Skip to content

Commit

Permalink
chore(docs): issues/406 spandx config notes (#425)
Browse files Browse the repository at this point in the history
  • Loading branch information
cdcabrera committed Sep 29, 2020
1 parent 9de02d0 commit 1cd091c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,16 @@ This project makes use of reserved DOM attributes used by the QE team.
1. Attribute `data-test`
DOM attributes with `data-test=""` are used by QE as a means to identify specific DOM elements.
### Reserved Files
#### Spandx Config
The configuration file(s) within this directory are utilized primarily during the `$ yarn start:proxy` local development run.
This file(s) has multiple team and build dependencies. **Before relocating/moving this file(s) the appropriate teams should be informed.**
- Development team
- QE team
There is a related integration test snapshot(s), `./tests/platform.test.js` that will need to be updated if this file(s) is updated.
## Testing
To test content you'll need to have Node and Yarn installed.
Expand Down
4 changes: 4 additions & 0 deletions config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Spandx Config
This file(s) has multiple team and build dependencies. **Before relocating/moving this file(s) the appropriate teams should be informed.**

[See CONTRIBUTING.md for up-to-date information](../CONTRIBUTING.md#spandx-config)

0 comments on commit 1cd091c

Please sign in to comment.