Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Reenstated CONTRIBUTING.md

  • Loading branch information...
commit 00925b80ec94d13beeef0080de02fe210e026197 1 parent 0a8f414
@amolenaar amolenaar authored
Showing with 26 additions and 24 deletions.
  1. +26 −0 CONTRIBUTING.md
  2. +0 −24 bylawsForCommitters
View
26 CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# Bylaws for the committers of FitNesse.
+
+1. Use the coding style that you'll see in the
+ [extra/util/fitnesse.xml](https://github.com/unclebob/fitnesse/blob/master/extra/util/fitnesse.xml) file.
+ This is an IntelliJ IDEA file. You can move it into the `codestyles` directory somewhere beneath IntelliJ preferences home. I found it on my MAC
+ in `~/Library/Preferences/IntelijIDEA8/codestyles`.
+ If you can't use this file in your IDE then look carefully then you can emulate any of the source files in FitNesse.
+ Remember that **indentation level is 2 spaces**, and we **never use tabs**. Braces follow K&R style:
@ggramlich Collaborator

Indentation seems to be tabs only nowadays?

@amolenaar Collaborator

??

(I merged back this code after a way-to-big merge of test system refactorings. Original commit: daaecf6.)

@ggramlich Collaborator

When I look at the java files from the HEAD, then they are all indented by tabs. In this description, it says that

**indentation level is 2 spaces**, and we **never use tabs**.

This is a contradiction for me. Maybe I am looking wrong?

@amolenaar Collaborator
@ggramlich Collaborator

Now I see: all the files that I looked at yesterday, where indented by tabs. I specifically changed my eclipse settings for this not to mess up the formatting.
But now I see that there are lots of files indented by 2 spaces.
What a mess :-(
Maybe updated eclipse and idea formatter files and some style checking that causes the build to fail if indentation is wrong, might help.

@amolenaar Collaborator

Maybe add an extra build step in build.xml? To verify for tabs at least shouldn't be that hard. Figuring out if 2 or 4 space indentation is used is probably a little harder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+ ```
+ void f() {
+ //
+ }
+ ```
+
+2. Never commit changes without running BOTH the unit tests AND the acceptance tests. The ant target 'all' in
+ the build.xml file will run them both, but it's slow. I just use the IDE to run the unit tests, and then run the
+ acceptance tests with FitNesse.
+
+3. Please don't rush. You are never in a hurry with FitNesse. There are no deadlines. Keep this code as clean
+ as you can. Maintain the highest pride in your workmanship. Don't make messes. See the "Clean Code" book for more.
+
+4. Whenever you make a change, add a few sentences to the changeLog.txt file describing your changes. We used this file
+ to build the release notes.
+
+5. If you have any questions, ask [Uncle Bob](https://github.com/unclebob).
+
View
24 bylawsForCommitters
@@ -1,24 +0,0 @@
-BYLAWS for the committers of FitNesse.
-
-1. Use the coding style that you'll see in the extras/fitnesse.xml file. This is an intelliJ idea file.
-You can move it into the codestyles directory somewhere beneath intellij preferences home. I found it on my MAC
-in ~/Library/Preferences/IntelijIDEA8/codestyles
-
-If you can't use this file in your IDE then look carefully then you can emulate any of the source files in FitNesse.
-Remember that indentation level is 2 spaces, and we never use tabs. Braces follow K&R style:
- void f() {
- //
- }
-
-2. Never commit changes without running BOTH the unit tests AND the acceptance tests. The ant target 'all' in
-the build.xml file will run them both, but it's slow. I just use the IDE to run the unit tests, and then run the
-acceptance tests with FitNesse.
-
-3. Please don't rush. You are never in a hurry with FitNesse. There are no deadlines. Keep this code as clean
-as you can. Maintain the highest pride in your workmanship. Don't make messes. See the "Clean Code" book for more.
-
-4. Whenever you make a change, add a few sentences to the changeLog.txt file describing your changes. We used this file
-to build the release notes.
-
-5. If you have any questions, ask Uncle Bob. unclebob@objectmentor.com.
-
Please sign in to comment.
Something went wrong with that request. Please try again.