From 54d243c84a8d9f95e5ee3e5dc14a72d77346aea1 Mon Sep 17 00:00:00 2001 From: Sean Madsen <sean@seanmadsen.com> Date: Tue, 10 Jan 2017 16:50:14 -0700 Subject: [PATCH] Direct import of wiki page "Recommendations" https://wiki.civicrm.org/confluence/display/CRMDOC/Recommendations (and wiki redirect to go with it) --- docs/basics/planning.md | 34 ++++++++++++++++++++++++++++++++++ redirects/wiki-crmdoc.txt | 3 ++- 2 files changed, 36 insertions(+), 1 deletion(-) diff --git a/docs/basics/planning.md b/docs/basics/planning.md index 1dc4f9a9..78b4e93d 100644 --- a/docs/basics/planning.md +++ b/docs/basics/planning.md @@ -57,3 +57,37 @@ selected for future releases. MIH work is carried out by the core team or trusted consultants. You can see a list of current MIH online at [http://civicrm.org/mih](http://civicrm.org/mih). If you think your project would make a good MIH, discuss it with the core team. + + +# Recommendations + + + +- Use Git and Github for revision control. The official CiviCRM + repositories are housed on Github. If you use Github you will find + it easy to access the latest source-code, to submit pull requests + for any patches you create and to collaborate with many other + CiviCRM developers who also use Github. See [Contributing to + CiviCRM using + GitHub](/confluence/display/CRMDOC/Contributing+to+CiviCRM+using+GitHub) + for more details.\ + \ +- Whenever possible package the feature you are developing as a native + extension created using Civix, the CiviCRM extension builder. A + native extension is easy to install on all you own sites and easy to + share with the CiviCRM community. Civix is a command-line tool + which generates the boilerplate code required for some common + development tasks. Instructions for installing Civix can be found at + [https://github.com/totten/civix/](https://github.com/totten/civix/).\ + \ +- Use the CiviCRM API to access and manage CiviCRM data in any patch, + native extension, CMS module, or external program that you + develop. The API will function as expected with every new release + and backwards compatibility of the API is maintained for several + versions of CiviCRM. See [Using the + API](/confluence/display/CRMDOC/Using+the+API).\ + \ +- Follow the CiviCRM [Coding + Standards](/confluence/display/CRMDOC/Coding+Standards). If everyone + follows the coding standards then all development work will be + easier as the structure will be more uniform. diff --git a/redirects/wiki-crmdoc.txt b/redirects/wiki-crmdoc.txt index 5c51f38f..ca4c342b 100644 --- a/redirects/wiki-crmdoc.txt +++ b/redirects/wiki-crmdoc.txt @@ -1,4 +1,5 @@ Documentation+Infrastructure+Canary develop The+developer+community basics/community Create+an+Extension extensions/basics -Before+you+start basics/planning \ No newline at end of file +Before+you+start basics/planning +Recommendations basics/planning \ No newline at end of file -- GitLab