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!