Merge pull request #246 from bp-cos/feature/pr_template

feat(eng-1234): Added a pull request template and updated the readme

Author: bp-cos

.github/pull_request_template.md

@@ -0,0 +1,38 @@
+<!--
+  Before you submit your Pull Request, make sure you picked the correct branch:
+    - For hotfixes, select "master" as the target branch
+    - For new features and non-hotfix bugfixes, select "develop" as the target branch
+    - For release feature fixes, select the relevant release branch (release/X.Y.Z) as the target branch
+
+  Ticketd PRs should be prefixed with the ticket id, e.g. `feat(ENG-123): some really great stuff`
+-->
+
+- Ticket: []
+- Feature flag: n/a
+
+## Purpose
+
+<!-- Describe the purpose of your changes. -->
+
+## Summary of Changes
+
+<!-- Briefly describe or list your changes. -->
+
+## Screenshot(s)
+
+<!-- Attach screenshots if applicable. -->
+
+## Side Effects
+
+<!-- Any possible side effects? (https://en.wikipedia.org/wiki/Side_effect_%28computer_science%29) -->
+
+## QA Notes
+
+<!--
+  Does this change need QA? If so, this section is required.
+    - What pages should be tested?
+    - Is cross-browser testing required/recommended?
+    - What edge cases should QA be aware of?
+    - What level of risk would you expect these changes to have?
+    - For each feature flag (if any), what is the expected behavior with the flag enabled vs disabled?
+-->

README.md

@@ -1,43 +1,33 @@
-# OSF
+# Open Science Framework Angular Project
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.2.0.
+This is the front-end angular repository for the Open Science Framework (OSF).
 
-## Development server
+## Running the project
 
-To start a local development server, run:
+1. npm install
+2. npm run start
+3. browse to localhost:4200
 
-```bash
-ng serve
-```
+## Testing the project
 
-Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
+The project uses jest for unit testing.
+A "counter" script executes before and after each test run to track how many times the unit
+tests are run locally. The output is displayed.
 
-## Code scaffolding
+1. npm run test (single test run)
+2. npm run test:watch (single run after file save)
+3. npm run test:coverage (code coverage results)
+   - all commits must pass the local pipeline for test coverage
+4. npm run test:check-coverage-thresholds
+   - Verifies newly added tests match the thresholds
+   - This is only used until we hit 100% test coverage
+   - all commits must pass the local pipeline for test coverage
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+## Github pipeline
 
-```bash
-ng generate component component-name
-```
+The `.github` folder contains the following:
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
-
-```bash
-ng generate --help
-```
-
-## Building
-
-To build the project run:
-
-```bash
-ng build
-```
-
-This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
-
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
-
-## Additional Resources
-
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+1. The test run "counter" scripts
+2. The "counter" file
+3. The github action work flow scripts
+4. The github PR templates