Skip to content

Commit 48270c0

Browse files
committed
Update README.md
1 parent 5c7f08a commit 48270c0

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,23 @@
1-
aem-samples
1+
AEM Samples
22
===========
3-
43
Code samples, best practices, exercises, tutorials. Just too little to be in their own repo. (help them grow up ;)
4+
5+
What to contribute to this repository
6+
-------------------------------------
7+
If you have a small piece of code, a micro project or just a best practice you want to share, but it's too small to be in its own repository, you can push it here.
8+
9+
How to contribute
10+
-----------------
11+
Just push your code/project in a top level folder. Please don't forget to provide a great README specific for you mocro project to properly describe it and let others know how they can use it or let it grow.
12+
13+
Can a micro project be extracted in a new repostory?
14+
----------------------------------------------------
15+
Yes. With <code>git subtree</code> it is possible to extract any folder from this repository and to transfer it to a new repository, keeping its history safe so you don't break the communication.
16+
17+
When does your project need its own repository?
18+
-----------------------------------------------
19+
* when it provides a well defined and unique extension/best-practice use case
20+
* when it is engaging more than 1 active contributors (so communication doesn't get mixed with other micro projects)
21+
* when it needs its own issue tracker or wiki
22+
* When it needs its own continuous integration
23+
* when you think it's time for it

0 commit comments

Comments
 (0)