Skip to content

Commit 141a65f

Browse files
committed
Extended README with some contribution guidelines.
Missing parts: * test methods naming convetions (as it is still part of ongoing discussion) * preferred libraries
1 parent 36a8957 commit 141a65f

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,24 @@ When developing and runing them from IDE, remember to activate the profile befor
3838

3939
To learn more about Arquillian please refer to the [Arquillian Guides](http://arquillian.org/guides/)
4040

41+
## How to contribute ##
42+
43+
With your help we can improve this set of samples, learn from each other and grow the community full of passionate people who care about the technology, innovation and code quality. Every contribution matters!
44+
45+
There is just a bunch of things you should keep in mind before sending a pull request, so we can easily get all the new things incorporated into the master branch.
46+
47+
### Some coding principles ###
48+
49+
* When creating new source file do not put (or copy) any license header, as we use top-level license (MIT) for each and every file in this repository.
50+
* Please follow JBoss Community code formatting profile as defined in the [jboss/ide-config](https://github.com/jboss/ide-config#readme) repository. The details are explained there, as well as configurations for Eclipse, IntelliJ and NetBeans.
51+
52+
### Small Git tips ###
53+
54+
* Make sure your [fork](https://help.github.com/articles/fork-a-repo) is always up-to-date. Simply run ``git pull upstream master`` and you are ready to hack.
55+
* When developing new features please create a feature branch so that we incorporate your changes smoothly. It's also convenient for you as you could work on few things in parallel ;) In order to create a feature branch and switch to it in one swoop you can use ``git checkout -b my_new_cool_feature``
56+
57+
That's it! Welcome in the community!
58+
4159
## CI Job ##
4260

4361
* [WildFly](https://arungupta.ci.cloudbees.com/job/Java%20EE%207%20Samples%20on%20WildFly-cb/)

0 commit comments

Comments
 (0)