From 317d712954583ab7d0e89cf8bf5ad1c778d2ba86 Mon Sep 17 00:00:00 2001 From: Ricardo Crudo Date: Thu, 1 Oct 2015 23:11:18 -0300 Subject: [PATCH] updating and renaming CONTRIBUTING file --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ CONTRIBUTING.txt | 27 --------------------------- 2 files changed, 33 insertions(+), 27 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 CONTRIBUTING.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..df398a87 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +How to contribute +================= + +If you want to contribute to the libraries in any way such as adding new components +or fixing existing ones, you are more than welcome to submit a pull request on GitHub for +the relevant repository. + +If you are new to GitHub, please check out this guide +[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source) +before you start. + +When creating/editing/fixing a symbol or footprint a set of conventions (a.k.a rules) +should be followed. They are the +[KiCad Library Convention](https://github.com/KiCad/kicad-library/wiki/Kicad-Library-Convention), +or KLC for short. This convention aims to make symbols and footprints have a +unique standard which is valuable in many aspects. Please, read the KLC carefully and +make sure your pull request is compliant with it. Librarians often are very demanding +about respecting the KLC. + +Note that the KLC is in some way a newcomer, this mean there are several symbols and +footprints in the KiCad repositories that are not KLC compliant yet. However, +there is an [effort](https://github.com/KiCad/kicad-library/wiki/Status-of-the-libraries) +to make all libraries KLC compliant. You can also help by doing some work in this +direction. + +When possible, take an already existing KLC symbol/footprint as an example to +create/edit symbols and/or footprints. Furthermore, you can use the +[kicad-library-utils](https://github.com/KiCad/kicad-library-utils) scripts to help +you check/fix KLC issues. For more information about how to use the scripts +please look at the README.md file in the repository. It is important to know that the +scripts does not cover all KLC rules, which means that if you got no issues reported +by script, this does not imply your submission will be accepted or that it is not +violating the KLC rules. \ No newline at end of file diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt deleted file mode 100644 index 520e7f61..00000000 --- a/CONTRIBUTING.txt +++ /dev/null @@ -1,27 +0,0 @@ -How to Contribute to KiCad Libraries -======================== - - -1) If you don't have one, create an account on www.github.com. - -2) Fork the repository on which you want to work, under your account: - https://help.github.com/articles/fork-a-repo - -3) Clone your newly created fork: - https://help.github.com/articles/fetching-a-remote - -4) Do your modifications using a text editor or the library editor: - https://github.com/KiCad/kicad-library/blob/master/KiCad_Library_Convention.txt - -5) Commit your changes: - git add -A - git commit -m "place your commit message here" - -6) Push to your branch: - git push - -7) Create a pull request: - https://help.github.com/articles/using-pull-requests - Include your references, for example a datasheet, in the comments. - -8) Wait until a librarian approves your work. Discussion and corrections might be needed.