From a1cd9d2ec17dc2d3f0d0aa0037ef45bbe4421d44 Mon Sep 17 00:00:00 2001 From: Lars Brinkhoff Date: Tue, 3 May 2016 14:52:32 +0200 Subject: [PATCH] Contribution Guideline. --- README.md | 2 ++ contributing.md | 10 ++++++++++ 2 files changed, 12 insertions(+) create mode 100644 contributing.md diff --git a/README.md b/README.md index 730848b..076182e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ This repository contains the documentations for various CPUs. It contain data sheets, programmer's manuals, quick reference cards, and the like. +Before submitting a pull request, [Contribution Guildelines](contributing.md). + | Subfolders | Description | | ---------- | ----------- | | 8085 | Intel 8085 | diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..56be535 --- /dev/null +++ b/contributing.md @@ -0,0 +1,10 @@ +## Contibution Guidelines + +Documentation for new CPUs or MCUs are happily accepted. It's +preferred to add processor family architecture documents. + +The GitHub 1G size limit on repositories is a concern. If a +subdirectory grows large, please add it as a git submodule. The +submodule repository should belong to the +[awesome-cpus](https://github.com/awesome-cpus) origanization. +Everyone are welcome to join.