From 3f6869dd4b791611cd836591da058900f4e8987e Mon Sep 17 00:00:00 2001 From: Peter 201943 Mangelsdorf <pjm349@drexel.edu> Date: Sun, 13 Feb 2022 02:58:45 -0500 Subject: [PATCH] update styling in readme; update changelog with notice; layout contributing document; update notes --- CHANGELOG.md | 4 +++ README.md | 4 +-- documents/developers/CONTRIBUTING.md | 51 +++++++++++++++++++++++++++- documents/discussions/2022-02-12.md | 6 ++++ 4 files changed, 62 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db34545..ca74a90 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,10 @@ # CHANGELOG +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + ## [2022-02-13]() ### Added diff --git a/README.md b/README.md index 2307cb2..b4a8ba6 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ By SE420 Open Source Engineering Team Blue for FA22Q2 "Winter" at [Drexel Univer See the latest discussion [notes](documents/discussions/) for more detailed information, including proposals. -If you have a security concern, please check the [SECURITY](documents/public/SECURITY.md) for help. +If you have a security concern, please check the [`SECURITY`](documents/public/SECURITY.md) for help. ## Getting Started @@ -45,7 +45,7 @@ See [**Issues**](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues) fo ## Contributing ### Guidelines -Please see [CONTRIBUTING](documents/developers/CONTRIBUTING.md) and [CONDUCT](documents/developers/CONDUCT.md) for specifics. +Please see [`CONTRIBUTING`](documents/developers/CONTRIBUTING.md) and [`CONDUCT`](documents/developers/CONDUCT.md) for specifics. ### Accepting Changes This is a low-priority project and as such pull requests are not likely to be accepted. diff --git a/documents/developers/CONTRIBUTING.md b/documents/developers/CONTRIBUTING.md index 5522350..dc452f8 100644 --- a/documents/developers/CONTRIBUTING.md +++ b/documents/developers/CONTRIBUTING.md @@ -1,4 +1,53 @@ # Contributing -TODO +## Contents +- [Contents](#contents) +- [Pre Knowledge](#pre-knowledge) + - [Code](#code) + - [Documents](#documents) +- [Processes](#processes) + - [Code Process](#code-process) + - [Document Process](#document-process) +- [Internal Outreach](#internal-outreach) + - [Team Blue](#team-blue) + - [Other Teams](#other-teams) + - [Instructor](#instructor) + - [Drexel IT](#drexel-it) +- [External Outreach](#external-outreach) +- [Code Standards](#code-standards) + - [Guests](#guests) + - [Testing](#testing) +- [Document Standards](#document-standards) + +## Pre Knowledge + +### Code + +### Documents + +## Processes + +### Code Process + +### Document Process + +## Internal Outreach + +### Team Blue + +### Other Teams + +### Instructor + +### Drexel IT + +## External Outreach + +## Code Standards + +### Guests + +### Testing + +## Document Standards diff --git a/documents/discussions/2022-02-12.md b/documents/discussions/2022-02-12.md index 369cf4b..89d54c1 100644 --- a/documents/discussions/2022-02-12.md +++ b/documents/discussions/2022-02-12.md @@ -82,6 +82,12 @@ - [(Example) Contributing to Python](https://github.com/python/cpython/blob/main/.github/CONTRIBUTING.rst) - [(Example) Gitlab's "Individual contributor license agreement"](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/legal/individual_contributor_license_agreement.md) - [(Example) Gitlab's "Process.Md"](https://gitlab.com/gitlab-org/gitlab/-/blob/master/PROCESS.md) +- [(Example) Godot Engine's "Contributing.Md"](https://github.com/godotengine/godot/blob/master/CONTRIBUTING.md) +- [(Example) Lightning Network Developers' Code Contribution Guidelines](https://dev.lightning.community/contribute/) +- [(Example) DSpace Software's Code Contribution Guidelines](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines) +- [(Example) Google Tensorflow's Contributing guidelines](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md) +- [(Example) Microsoft's Mixed Reality Toolkit Coding Guidelines](https://docs.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/contributing/coding-guidelines?view=mrtkunity-2021-05) (Peter's personal favorite) +- [(Example) Atom Editor's Contributing Guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) ## Arch Files - Filename: `ARCH.md` -- GitLab