Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
brienne
Developer Documentation
Commits
b8cbd233
Commit
b8cbd233
authored
8 years ago
by
Erich Schulz
Browse files
Options
Downloads
Patches
Plain Diff
tweaks, promote builkit and testing
parent
7b45863e
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/basics/planning.md
+28
-7
28 additions, 7 deletions
docs/basics/planning.md
with
28 additions
and
7 deletions
docs/basics/planning.md
+
28
−
7
View file @
b8cbd233
...
...
@@ -48,32 +48,53 @@ the [#civicrm](https://twitter.com/hashtag/civicrm) hashtag, tell similar
CiviCRM users and organisations and so on.
The more feedback you can get the better.
If you get stuck writing your requirements and specification, or would
like to get more background, have a look at some
[
existing requirements and specifications
](
https://wiki.civicrm.org/confluence/display/CRM/Requirements+and+specifications
)
from CiviCRM developers.
!!!tip
If you get stuck writing your requirements and specification, or would
like to get more background, have a look at some
[
existing requirements and specifications
](
https://wiki.civicrm.org/confluence/display/CRM/Requirements+and+specifications
)
from CiviCRM developers.
## Recommendations
**
Use Git and
[GitHub](https://github.com/)**
for revision control.
**
Open a free
[GitHub](https://github.com/)
account
**
for revision control.
The official CiviCRM
[
repositories
](
https://github.com/civicrm
)
are housed on GitHub. If you use GitHub you will find
are housed
in
`git`
repositories
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.
**Install the [buildkit](https://github.com/civicrm/civicrm-buildkit)**
,
ideally as a
[
vagrant virtual-machine
](
https://github.com/civicrm/civicrm-buildkit-vagrant
)
or using one of available
`docker`
images (
[
1
](
https://github.com/progressivetech/docker-civicrm-buildkit
)
,
[
2
](
https://github.com/ErichBSchulz/dcbk
)
). The buildkit is not an absolute
requirement but it is definitely the fastest path to a good development
experience!
**From the outset, [automate testing](https://wiki.civicrm.org/confluence/display/CRMDOC/Testing)**
.
In the current climate of rapid evolution of not just CiviCRM, but
also it's myriad of dependancies, automated testing of PHP code with
`phpunit`
and javascript with tools like
`karma`
and
`jasmine`
is essential. Start all
your work by considering how you will provide automated testing for it.
Starting with the buildkit will make this much simpler for you to set up.
Getting started with unit-testing may seem daunting and onerous when you start,
but you will soon come to love the freedom it gives you. If you are
unsure how to proceed with testing ask the
[
community
](
/basics/community
)
.
**Create a native [extension](/extensions/basics)**
.
If you have new functionality to add to CiviCRM, it probably belongs in an
extension. "Native" extensions will install into all CiviCRM sites
regardless of the underlying CMS used (Drupal or Wordpress), making it easy to
share your extension with the CiviCRM community.
**Use the [API](/api/general)**
to access and manage CiviCRM data in any patch,
**Use the [API](/api/general)
and [hooks](/hook)
**
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.
**Avoid [hacking the core](/core/hacking)**
of CiviCRM unless you understand
the implications.
**
Follow the
[
Coding Standards
](
https://wiki.civicrm.org/confluence/display/CRMDOC/Coding+Standards
)
**
for uniform structure that will make everyone's development work easier.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment