Skip to content

Commit

Permalink
Reenstated CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amolenaar committed Mar 9, 2013
1 parent 0a8f414 commit 00925b8
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 24 deletions.
26 changes: 26 additions & 0 deletions 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:

This comment has been minimized.

Copy link
@ggramlich

ggramlich Sep 24, 2013

Collaborator

Indentation seems to be tabs only nowadays?

This comment has been minimized.

Copy link
@amolenaar

amolenaar Sep 24, 2013

Author Collaborator

??

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

This comment has been minimized.

Copy link
@ggramlich

ggramlich Sep 24, 2013

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?

This comment has been minimized.

Copy link
@amolenaar

amolenaar via email Sep 25, 2013

Author Collaborator

This comment has been minimized.

Copy link
@ggramlich

ggramlich Sep 25, 2013

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.

This comment has been minimized.

Copy link
@amolenaar

amolenaar Sep 25, 2013

Author 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.

```
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).

24 changes: 0 additions & 24 deletions bylawsForCommitters

This file was deleted.

0 comments on commit 00925b8

Please sign in to comment.