From 2be2c3bb97ffe14a4959378ccaaa41e47bfebd27 Mon Sep 17 00:00:00 2001
From: Clay McLeod <clay.l.mcleod@gmail.com>
Date: Fri, 25 Aug 2023 12:04:53 -0500
Subject: [PATCH] docs: adds guidelines for contributing to README

---
 .github/pull_request_template.md |  1 +
 README.md                        | 15 ++++++++++++++-
 2 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 48bbab8..6f7bf56 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -5,4 +5,5 @@ Before submitting this PR, please make sure:
 - [ ] You have added a few sentences describing the PR here.
 - [ ] You have added yourself or the appropriate individual as the assignee.
 - [ ] You have added the relevant groups/individuals to the reviewers.
+- [ ] Your commit messages conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
 - [ ] You have updated the README or other documentation to account for these changes (when appropriate).
diff --git a/README.md b/README.md
index 45f0dbb..3913f67 100644
--- a/README.md
+++ b/README.md
@@ -14,4 +14,17 @@
     <a href="https://github.com/cbiit/ccdi-federation-api/issues/new?assignees=&labels=&template=bug_report.md&title=Descriptive%20Title&labels=bug">Report A Bug</a>
     <br />
   </p>
-</p>
\ No newline at end of file
+</p>
+
+## Contributing
+
+### Development Process
+
+- Changes are first discussed in the [discussions](https://github.com/cbiit/ccdi-federation-api/discussions) section of the repo. The purpose of these discussions is to describe your idea(s), receive feedback from other implementors, and ultimately gain support within the community for these features.
+- Once a set of changes has been approved via the discussions mechanism, work can commence on a [pull request](https://github.com/cbiit/ccdi-federation-api/discussions) implementing these changes.
+
+### Repository Details
+
+- This repository uses the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) style for commit messages. Please make sure all commits conform to this style.
+- This repository, as well as the API itself, are versioned using the latest version of [Semantic Versioning](https://semver.org/).
+- All changes will either be squashed and merged or rebased off of the `main` branch—no merge commits are allowed in this repository.
\ No newline at end of file