Revision [1078]

Last edited on 2009-10-30 00:16:35 by ChrisBuechler
Additions:
- If you commit a kernel change that requires a userland configuration change of any type, then you also must make sure there is PHP code to control the userland change as needed (different sysctls, different means of configuring something, etc.).
Deletions:
- If you commit a kernel change that requires a PHP configuration change, then you also must make sure there is PHP code to control the change as needed.


Revision [1077]

Edited on 2009-10-30 00:12:00 by ChrisBuechler
Additions:
- You break the code, you fix it. Period. Even if your code breaks another subsystem. Your code caused the fallout. Yes this is not glamorous but it is the right thing to do (or back your code out until a proper fix can be obtained).
- Avoid changing the XML configuration structure whenever possible. Where that is infeasible, do not commit code that changes the XML configuration structure without adding configuration upgrade code at the same time.
Deletions:
- You break the code, you fix it. Period. Even if your code breaks another subsystem. Your code caused the fallout. Yes this is not glamorous but it is the right thing to do (or back your code out until a proper fix can be obtained).
- Do not commit code that changes the configuration structure without adding configuration upgrade code at the same time.


Revision [1076]

Edited on 2009-10-30 00:10:47 by ChrisBuechler
Additions:
- If you commit a kernel change that requires a PHP configuration change, then you also must make sure there is PHP code to control the change as needed.
- Do not commit code that changes the configuration structure without adding configuration upgrade code at the same time.
Deletions:
- If you commit a kernel change then you also need to make sure there is PHP code to control the change if need. Example: kernel patch introduces a on off switch for a subsystem.
- Do not commit code unless you plan on adding upgrade code in a reasonable amount of time (1-2 weeks max) if it changes the config.xml layout in any way.


Revision [1075]

Edited on 2009-10-30 00:07:03 by GeekGod
Additions:
- Do not commit code unless you plan on adding upgrade code in a reasonable amount of time (1-2 weeks max) if it changes the config.xml layout in any way.
Deletions:
- Do not commit code unless you plan on adding upgrade code in a reasonable amount of time (1-2 weeks max)


Revision [1074]

Edited on 2009-10-30 00:01:25 by GeekGod
Additions:
- If you commit a kernel change then you also need to make sure there is PHP code to control the change if need. Example: kernel patch introduces a on off switch for a subsystem.
Deletions:
- If you commit a kernel change then you also need to make sure there is PHP code.


Revision [1073]

Edited on 2009-10-30 00:00:42 by GeekGod
Additions:
- You break the code, you fix it. Period. Even if your code breaks another subsystem. Your code caused the fallout. Yes this is not glamorous but it is the right thing to do (or back your code out until a proper fix can be obtained).
Deletions:
- You break the code, you fix it. Period. Even if your code breaks another subsystem. Your code caused the fallout. Yes this is not glamorous but it is the right thing to do.


Revision [1072]

Edited on 2009-10-29 23:58:07 by GeekGod
Additions:
- Do not commit code unless you plan on adding upgrade code in a reasonable amount of time (1-2 weeks max)
Deletions:
- Do not commit code unless you plan on adding upgrade in a reasonable amount of time (1-2 weeks max)


Revision [1071]

Edited on 2009-10-29 23:57:45 by GeekGod
Additions:
- You break the code, you fix it. Period. Even if your code breaks another subsystem. Your code caused the fallout. Yes this is not glamorous but it is the right thing to do.
Deletions:
- You break the code, you fix it. Period.


Revision [1070]

Edited on 2009-10-29 23:57:06 by GeekGod
Additions:
- You break the code, you fix it. Period.
- If you commit a kernel change then you also need to make sure there is PHP code.
- Do not commit code unless you plan on adding upgrade in a reasonable amount of time (1-2 weeks max)
Deletions:
- You break the code, you fix it. Period.
- If you commit a kernel change then you also need to make sure there is PHP code.
- Do not commit code unless you plan on adding upgrade in a reasonable amount of time (1-2 weeks max)


Revision [1069]

Edited on 2009-10-29 23:56:43 by GeekGod
Additions:
- You break the code, you fix it. Period.
- If you commit a kernel change then you also need to make sure there is PHP code.
- Do not commit code unless you plan on adding upgrade in a reasonable amount of time (1-2 weeks max)


Revision [1051]

Edited on 2009-10-29 19:53:04 by ChrisBuechler
Additions:
- Never commit untested code.
- Never commit anything to any branch that knowingly causes a regression.
- Any major or high risk changes must first be done in a git clone and reviewed by another committer before merging into mainline.
- Pre-commit authorization such as in OpenBSD isn't used in pfSense except in the case of major changes. We do however run sanity checks on committed files and use access control to keep commits to authorized branches.
- special characters (e.g. umlauts) need to be coded as HTML entities. see: http://en.selfhtml.org/html/referenz/zeichen.htm (in German, sorry. but the table is self explanatory)
Deletions:
- Don't revert someone elses commits without really good cause (the code is completely broken and you can't get ahold of the committer)
- Massive changes to code that another developer makes significant changes to should be run past that dev as best practice
- Incorrectly reverting someone elses commit and causing them to hunt for a bug they know they fixed grants them the right to send the bar bill to you for a month :)
- Don't knowingly commit code that breaks the tree; sometimes you will have code that's work in progress than needs to be committed, try to commit it somewhere it won't break the tree (ie. interfaces_new.inc instead of interfaces.inc).
- Pre-commit authorization such as in OpenBSD isn't used in pfSense, we do however run sanity checks on committed files and use a cvs acl script to keep commits to authorized branches.
- special characters (e.g. umlauts) need to be coded as HTML entities. see: http://en.selfhtml.org/html/referenz/zeichen.htm (in German, sorry. but the table is self explaining)


Revision [380]

Edited on 2008-07-21 00:25:28 by ChrisBuechler
Additions:
- the language=""JavaScript"" attribute for <script /> tags is deprecated. Use the type="text/javascript" attribute instead.
- always use lowercase attribute names for calling ""JavaScript"" events (e.g. onclick="foobar();")
- There shouldn't be a space between a function name and its argument list:
Deletions:
- the language="JavaScript" attribute for <script /> tags is deprecated. Use the type="text/javascript" attribute instead.
- always use lowercase attribute names for calling JavaScript events (e.g. onclick="foobar();")
- There shouldn't be a space between a function name and it's argument list:


Revision [299]

Edited on 2008-04-26 20:17:54 by GeekGod
Additions:
} else {
Deletions:
else {


Revision [64]

The oldest known version of this page was created on 2007-08-18 23:32:36 by ChrisBuechler
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki