From fb156413ed950a2d009af696a9eae9cd4effe04c Mon Sep 17 00:00:00 2001 From: Emily Chambers <31651921+evchambers@users.noreply.github.com> Date: Tue, 13 Jan 2026 09:10:26 +0000 Subject: [PATCH 1/7] Revise template README with detailed project information --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86ea234..7eddef0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# dataconnect-basic-template -A basic repository structure template +# Project Title + +## Overview + +Simple project overview. + +## Description + +A amore detailed paragraph about the purpose of project work here and overview of use. + +## Getting Started + +### Dependencies + +* Describe any software/library prerequisites needed + +### Installing + +* How/where to download code if applicable + +### Usage + +* How to run the code +* Step-by-step bullets +``` +Use code blocks like this for commands +``` + +## License + +This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details (if applicable) + +## Acknowledgments + +Any acknowledgements as required From 438e043b7396fe642e3748de3e2e32542b68c89c Mon Sep 17 00:00:00 2001 From: Emily Chambers <31651921+evchambers@users.noreply.github.com> Date: Tue, 13 Jan 2026 10:31:50 +0000 Subject: [PATCH 2/7] Add initial .gitignore file with instructions --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4ae0425 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +## Your repo should have a .gitignore file which tells Git which files and folders to ignore (not track) +## Please see https://github.com/github/gitignore for a useful list of templates From 5cf759efa6927b8d449f908e828078dd2579c268 Mon Sep 17 00:00:00 2001 From: Emily Chambers <31651921+evchambers@users.noreply.github.com> Date: Tue, 13 Jan 2026 11:33:03 +0000 Subject: [PATCH 3/7] Add related documentation section to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7eddef0..cded919 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ Simple project overview. A amore detailed paragraph about the purpose of project work here and overview of use. +## Related Documentation +* Link to internal Data Connect technical documentation (if repo is private) +* Relevant Jira tickets +* Relevant link + ## Getting Started ### Dependencies From 3fb67e9e46bc15aab96cfb9702e3684c10e2988f Mon Sep 17 00:00:00 2001 From: Emily Chambers <31651921+evchambers@users.noreply.github.com> Date: Tue, 13 Jan 2026 11:33:21 +0000 Subject: [PATCH 4/7] Fix typo in project description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cded919..428cd5b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Simple project overview. ## Description -A amore detailed paragraph about the purpose of project work here and overview of use. +A a more detailed paragraph about the purpose of project work here and overview of use. ## Related Documentation * Link to internal Data Connect technical documentation (if repo is private) From be8ae96c6c94ff19945c1aa32486b7b1a4c40180 Mon Sep 17 00:00:00 2001 From: Emily Chambers <31651921+evchambers@users.noreply.github.com> Date: Tue, 13 Jan 2026 11:33:34 +0000 Subject: [PATCH 5/7] Fix typo in project description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 428cd5b..e4eab15 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Simple project overview. ## Description -A a more detailed paragraph about the purpose of project work here and overview of use. +A more detailed paragraph about the purpose of project work here and overview of use. ## Related Documentation * Link to internal Data Connect technical documentation (if repo is private) From 738135d45fd58935b01460f41471b78f2987e2b0 Mon Sep 17 00:00:00 2001 From: Emily Chambers <31651921+evchambers@users.noreply.github.com> Date: Tue, 13 Jan 2026 11:38:17 +0000 Subject: [PATCH 6/7] Add project number to the title in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e4eab15..7bd5a50 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Project Title +# Project Title [Project Number DC000X] ## Overview From bffd55d3c3ef409047f3c09bf2e529c58924b080 Mon Sep 17 00:00:00 2001 From: Emily Chambers <31651921+evchambers@users.noreply.github.com> Date: Tue, 13 Jan 2026 12:20:36 +0000 Subject: [PATCH 7/7] Create CONTRIBUTING.md with contribution guidelines Added contribution guidelines for the repository. --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..585646c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contribution guidelines + +This repository is a template and the guide below is generic. It should be adapted for the specific requirements of your project. + +--- + +## Before you start + +- Ensure you have read the project's [`README.md`](./README.md). +- If you are proposing a new feature, open an issue/JIRA ticket first to discuss it. + +## Contribution Workflow +The general steps for contributing code are: + +1. Clone the code repository into your development environment (see the Development Setup section below for prerequisites and installation steps). +2. Create an issue or JIRA ticket that describes the user requirements, context, and possible solutions. +3. Create a branch for that issue. +4. Check out that branch. +5. Write your code and unit tests. +6. Run linters, formatters, and all unit tests locally. +7. Commit your changes to your local branch. +8. Push the changes to GitHub. +9. Create a pull request (PR). +10. Submit the PR for Code review using the GitHub PR review system. +11. Merge PR after approval.