Loading...
 
Skip to main content

History: 3 Rules

View published page Collapse Into Edit Sessions

Comparing version 19 with version 33

Go to current version
Lines: 5-14Lines: 5-14
 !!! In brief !!! In brief
-# __Respect Environment__

+ Tiki is both a software project and a community. The mix of both, contextualized on the Internet and in real life, is called ''The Environment''. Any change in Tiki should take in account its effect on the entire Tiki community and should allow for a balanced evolution with respect for the people and organizations that use it. Please make sure any code you commit [http://tiki.org/License|respects the LGPL license] and that you allowed to share it. Do not duplicate code or features, as this just creates more work for everyone to maintain. Re-use and extend code instead, and ask for help if you are unsure how, or unsure if there is similar code lying around.		 +# __Respect the Environment__

+ Tiki is both a software project and a community. The mix of both, contextualized on the Internet and in real life, is called The Environment. Any change in Tiki should take into account its effect on the entire Tiki community and should allow for a balanced evolution with respect for the people and organizations that use it. Please make sure any code you commit ((tw:License|respects the LGPL license)) and that you are allowed to share it. Do not duplicate code or features, as this just creates more work for everyone to maintain. Reuse and extend code instead, and ask for help if you are unsure how, or unsure if there is similar code lying around.
 # __Commit early, Commit often__ # __Commit early, Commit often__
-+ SVN is the central point in Tiki collaborative development. Commits should be frequent, even in the early stages, to offer an opportunity of interaction between contributors. Early commits provide more chances for feedback and for the community to start to assimilate the ideas you propose. ++ [https://gitlab.com/tikiwiki/tiki|Git] is the central point in Tiki's collaborative development. Contributions should be frequent, even in the early stages, to offer an opportunity for interaction between contributors. Early merge requests in draft provide more opportunities for feedback and for the community to start to assimilate the ideas you propose. [http://community.redhat.com/blog/2015/03/upstream-first-turning-openstack-into-an-nfv-platform/|"Upstream first" is the cheapest, most sustainable way to innovate on an open source platform].
 # __Make it Optional__ # __Make it Optional__
-+ Tiki is used in many smaller contexts and its modularity is key to adoption in those areas. Help preserve this flexibility by making your changes optional whenever possible, accessible for tuning to the admin at least, via admin panels. ++ Tiki is used in many smaller contexts and its modularity is key to adoption in those areas. Help preserve this flexibility by making your changes optional whenever possible, accessible for tuning to the admin at least, via admin panels. This is also good for security as if a security vulnerability is discovered, a feature can be deactivated.
 --- ---
Lines: 16-44Lines: 16-38
 # __Think about other users__ # __Think about other users__
-+ Tiki is both a piece of software and a community of people. This combination means that we invite you, as a member of the community, to think not only about the code, but also the wide variety of people who use Tiki everyday. Consider your proposed changes in this context. We believe that a careful, thoughtful, and highly collaborative approach is a way to maintain respect for both the code and the people who depend on it. Rather than seeing Tiki as a game, we invite you to see Tiki as a manner of producing change. Recognize that your code could affect the lives of people. ++ Tiki is both a piece of software and a community of people. This combination means that we invite you, as a member of the community, to think not only about the code but also about the wide variety of people who use Tiki every day. Consider your proposed changes in this context. We believe that a careful, thoughtful, and highly collaborative approach is a way to maintain respect for both the code and the people who depend on it. Rather than seeing Tiki as a game, we invite you to see Tiki as a manner of producing change. Recognize that your code could affect the lives of people.
 # __Share Early, Share Often__ # __Share Early, Share Often__
-+If you have an idea for an improvement, new feature, performance enhancement, or anything else of that nature, be quick to share it. Be proud of your idea and get it out there on the e-mail list or IRC channel. Be open to questions and ideas that others may have. As you work out your ideas and implementations, share your progress and approach often. Ask for advice and feedback. There are many smart & dedicated people in the Tiki Community who love to help. Documenting what you are doing on Tiki.org keeps others up to date with changes. You are encouraged to create a wiki page for your idea so others can comment. Create a showcase site to show off your work in progress. Once it basically works and the community likes it, commit your code to SVN. Yes, it may be imperfect, nevertheless by following the maxim of Release Early, Release Often others are more able to help with development and debugging.

+__One BIG caution__: Don't commit sweeping or wide-reaching changes to SVN until there is community consensus, or at least approval from one or more of the project administrators. They are those who have that designation in the list of developers. Checking with others is the right way to develop code and helps us to avoid really screwing up other people's lives and projects. When in doubt, communicate! This could be on IRC, by email, or some other agreed upon method. For sweeping changes, it's encouraged to use an ((Experimental Branch)), which can be merged to trunk later


+ ''__A caution about the BIG caution__ : I feel it is impossible to reach consensus without effective code. Asking before is a matter of gathering information, not getting prior acceptance of something. Good decisions can provide bad implementations and in such cases there is a difficulty in correcting what was mutually agreed beforehand (without really knowing). Of course, that only applies to experienced coders __who are supposed to know what they are doing__. People who learn to code need to be particularly cautious. You decide whether this is for authoritative reasons or as a means of obtaining wisdom (if available). That's my 2 cents. -- mose''		 ++ If you have an idea for an improvement, new feature, performance enhancement, or anything else of that nature, be quick to share it. Be proud of your idea and get it out there on the e-mail list or chat channel. Be open to questions and ideas that others may have. As you work out your ideas and implementations, share your progress and approach often. Ask for advice and feedback. There are many smart and dedicated people in the Tiki Community who love to help. Documenting what you are doing on Tiki.org keeps others up to date with changes. You are encouraged to create a wiki page for your idea so others can comment. Create a showcase site to show off your work in progress. Make a draft merge request to show the community you are going in a certain direction. Yes, it may be incomplete, nevertheless, by following the maxim of Release Early, Release Often others are more able to help with development and debugging.

+ __One BIG caution__: Don't commit or accept merge requests for sweeping or wide-reaching changes until there is community consensus or at least approval from one or more of the project administrators. They are those who have that designation in the list of developers. Checking with others is the right way to develop code and helps us to avoid screwing up other people's lives and projects. When in doubt, communicate! This could be in the chat, by email, or by some other agreed upon method. For sweeping changes, it's encouraged to use an ((Experimental Branch)), which can be merged to trunk later


+ ''__A caution about the BIG caution__ : I feel it is impossible to reach a consensus without effective code. Asking before is a matter of gathering information, not getting prior acceptance of something. Good decisions can provide bad implementations and in such cases, there is difficulty in correcting what was mutually agreed upon beforehand (without really knowing). Of course, that only applies to experienced coders __who are supposed to know what they are doing__. People who learn to code need to be particularly cautious. You decide whether this is for authoritative reasons or as a means of obtaining wisdom (if available). That's my 2 cents. — mose''
 # __Make It Optional__ # __Make It Optional__
-+Tiki is used in the real world by MANY people for MANY different uses. Try to avoid forcing new features on everyone. Allow new features to be tuned and configured by the site admin, and, if at all possible, allow it to be turned off. At the very least, make sure that the default config doesn't change Tiki's behavior.

 ++ Tiki is used in the real world by many people for many different uses. Try to avoid forcing new features on everyone. Allow new features to be tuned and configured by the site admin, and, if at all possible, allow it to be turned off. At the very least, make sure that the default config doesn't change Tiki's behavior.
 !!! More good things to do !!! More good things to do
-* Register to the ((tw:Mailing Lists|SVN & Developers mailing list)). We need to have a way to join you if you have some comments to do on your commits.

* Hang out on [http://irc.tiki.org/|IRC


* Read ((Hello World

)
* Follow ((

))
 +* Register to the ((tw:Mailing Lists|code & Developers mailing list)). We need to have a way to join you if you have some comments to do on your commits.

* Hang out on https://app.gitter.im/#/room/#tiki-org_community:gitter.


* Read ((Hello World)

.
* Follow ((DevTips)).
 ! Alias ! Alias
 (alias(3Rules)) | (alias(Ceremony)) (alias(3Rules)) | (alias(Ceremony))
 ! Things to discuss ! Things to discuss
-* "default config doesn't change Tiki's behavior." -> "default config is the most common/expected" (This is subjective of course, which is why we have http://profiles.tiki.org). +* "default config doesn't change Tiki's behavior." -> "default config is the most common/expected" (This is subjective of course, which is why we have http://profiles.tiki.org ).
 * Clarify expectation about backward compatibility (How and when to break things) * Clarify expectation about backward compatibility (How and when to break things)

History

Information Version
08 Jul 23 03:51 UTC Marc Laporte 33
08 Jul 23 03:48 UTC Marc Laporte 32
08 Jul 23 03:47 UTC Marc Laporte 31
22 Apr 23 22:20 UTC drsassafras grammar improvements 30
22 Apr 23 19:32 UTC Marc Laporte Adapting 3 rules to 2023. IRC -> Gitter, and SVN -> Git which makes it easy to have draft pull requests, so it's less important to commit to trunk as soon as before 29
19 Apr 22 17:11 UTC Marc Laporte Another benefit 28
06 Jun 19 19:37 UTC Jean-Marc Libs 27
11 Apr 19 11:25 UTC Gary Cunningham-Lee Minor text edits. 26
24 Jul 18 14:53 UTC Jorge Sá Pereira 25
15 Apr 18 10:32 UTC Marc Laporte Re-saving page, hoping it will solve redirects from page alias 24
15 Oct 16 04:45 UTC drsassafras spelling and grammer fixes 23
24 May 15 20:21 UTC Marc Laporte https://tiki.org/forumthread56350 22
28 Apr 15 06:27 UTC Bernard Sfez / Tiki Specialist 21
18 Jul 14 18:17 UTC alex 20
02 Apr 14 07:57 UTC Xavier de Pedro 19
22 Jan 13 03:55 UTC Marc Laporte 18
29 Mar 12 00:14 UTC Marc Laporte Page renamed 17
31 Jan 11 23:30 UTC Philippe Cloutier 16
22 Oct 09 13:21 UTC Marc Laporte It should be obvious but better to clarify 15
13 Sep 09 20:59 UTC Marc Laporte 14
13 Sep 09 20:45 UTC Marc Laporte Preserve -> Respect (as discussed on dev-list) and various minor changes. 13
26 Jul 09 13:24 UTC sylvie greverend 12
14 Oct 08 13:18 UTC pkdille 11
15 Apr 08 08:33 UTC Xavier de Pedro added references to SVn for 1.10 onwards 10
12 Mar 08 08:04 UTC Marc Laporte and that you allowed to share it (for people working somewhere) 9
  • «
  • 1 (current)
  • 2
Show PHP error messages