This repository has been archived by the owner on Oct 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
58c6bad
commit 8ade808
Showing
3 changed files
with
25 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Code standards | ||
This comment has been minimized.
Sorry, something went wrong. |
||
|
||
In general, CiviCRM follow's the [Drupal Coding Standards](https://www.drupal.org/docs/develop/standards), but we have some minor modifications which are noted specifically in the other pages in this chapter. | ||
|
||
## Continuous integration | ||
|
||
Jenkins will automatically check all pull requests for code standards conformance, and code which does not meet the standards will not be merged. | ||
This comment has been minimized.
Sorry, something went wrong. |
||
|
||
|
||
## Tools | ||
|
||
If you have a development site with [buildkit]() you can use [Civilint](/tools/civilint.md) to check your code against CiviCRM's code standards. | ||
This comment has been minimized.
Sorry, something went wrong. |
||
|
||
You can also [set up your IDE](https://wiki.civicrm.org/confluence/display/CRMDOC/IDE+Settings+to+Meet+Coding+Standards) to lint your code. | ||
|
||
|
||
## Improving code conformance | ||
|
||
If you find code that is not meeting the standards, we encourage you to improve it! But please follow these guidelines when doing so: | ||
|
||
* Create a Jira issue for your code standard improvements which is separate from any other code changes you happen to be making at the time. | ||
* Isolate your code standards improvements into commits which do not contain otherwise unrelated changes. | ||
This comment has been minimized.
Sorry, something went wrong. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Coding