From f13cbfb9167e4ee9192fb2d2f3440d891c9bb3f6 Mon Sep 17 00:00:00 2001 From: Yan Justino Date: Thu, 1 Apr 2021 11:09:26 -0300 Subject: [PATCH 1/2] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 56f1848..cd86df1 100644 --- a/README.md +++ b/README.md @@ -77,8 +77,10 @@ The result will be: logo

-See more samples [here](https://github.com/8T4/c4sharp/tree/main/tests/C4Sharp.Tests/C4Model/Samples) +## Learn + +To learn more about `C4S` access our [wiki](https://github.com/8T4/c4sharp/wiki). ## Background -### Plantuml \ No newline at end of file +### Plantuml From 3a561f8cb9b3600596d1628d1c4c9538977fac00 Mon Sep 17 00:00:00 2001 From: Yan Justino Date: Thu, 1 Apr 2021 11:10:30 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cd86df1..d3ee15a 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,15 @@ The result will be: To learn more about `C4S` access our [wiki](https://github.com/8T4/c4sharp/wiki). -## Background - -### Plantuml +## Guide to contributing to a GitHub project +This is a guide to contributing to this open source project that uses GitHub. It’s mostly based on how many open sorce projects operate. That’s all there is to it. The fundamentals are: + +* Fork the project & clone locally. +* Create an upstream remote and sync your local copy before you branch. +* Branch for each separate piece of work. +* Do the work, write good commit messages, and read the CONTRIBUTING file if there is one. +* Push to your origin repository. +* Create a new PR in GitHub. +* Respond to any code review feedback. + +If you want to contribute to an open source project, the best one to pick is one that you are using yourself. The maintainers will appreciate it!