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 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. diff --git a/README.md b/README.md index 86ea234..7bd5a50 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# dataconnect-basic-template -A basic repository structure template +# Project Title [Project Number DC000X] + +## Overview + +Simple project overview. + +## Description + +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) +* Relevant Jira tickets +* Relevant link + +## 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