From b4c216163a5270c49261153f40a119798f6291b4 Mon Sep 17 00:00:00 2001 From: Robert Schadek Date: Sat, 18 Jun 2016 15:34:25 +0200 Subject: [PATCH 1/4] Link to Walter, Andrei Action List --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 291f6b1d268..13a57c6d840 100644 --- a/README.md +++ b/README.md @@ -27,5 +27,7 @@ I Want to Contribute -------------------- Great! +Walter and Andrei have veto rights when it comes to inclusion of new stuff into DMD, druntime, and phobos. So if you're looking to work on new stuff either pick something from the [list](https://wiki.dlang.org/Walter_Andrei_Action_List). Or get in contact with Walter or Andrei early during the design phase of your project. This way you can avoid a lot of frustration, by not having your project rejected after you already implemented it. + See the [CONTRIBUTING.md file](CONTRIBUTING.md). From 286b6d204a70c3ff635498e62659dbc6f75d22c1 Mon Sep 17 00:00:00 2001 From: Robert Schadek Date: Sun, 19 Jun 2016 21:25:33 +0200 Subject: [PATCH 2/4] more informative --- README.md | 41 ++++++++++++++++++++++++++++++++--------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 13a57c6d840..0c58642a1bb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -![D Logo](http://dlang.org/images/dlogo.png) Phobos Standard Library -=================================================================== +#![D Logo](http://dlang.org/images/dlogo.png) Phobos Standard Library + Phobos is the standard library that comes with the [D Programming Language](http://dlang.org) Compiler. @@ -10,8 +10,8 @@ Phobos is the standard library that comes with the * [API Documentation](http://dlang.org/phobos/) * [Wiki](http://wiki.dlang.org/) -Download --------- +# Download + Phobos is packaged together with the compiler. You should @@ -23,11 +23,34 @@ there is a [description in the wiki](http://wiki.dlang.org/Building_DMD). Phobos is distributed under Boost Software Licence. See the [licence file](LICENSE_1_0.txt). -I Want to Contribute --------------------- +#I Want to Contribute + + +## New packages in Phobos + + +Phobos is the standard library of the D programming language and thus tries to standardize APIs to ease development for many other programmers. +Hence it's great if you want to contribute and make Phobos even better, but there are some important points that you should pay attention too. + +### Blocking points for additions + + +In general there are some indications why something fits better to dub than to the standard library: + +- Low applicability / potential usage (e.g. QR Code generation, Tribune client) +- Many valid ways to do something (e.g. UI framework, web server API) +- Fast moving targets (e.g. CSS library, Game engine) + +The bottom line is that if you want to write an amazing library that touches one of those fields, go ahead! +With dub potential users can easily use your library and if it proves to be very popular, it might even find it's way to Phobos ;-) + +### Finding good points to contribute + -Great! -Walter and Andrei have veto rights when it comes to inclusion of new stuff into DMD, druntime, and phobos. So if you're looking to work on new stuff either pick something from the [list](https://wiki.dlang.org/Walter_Andrei_Action_List). Or get in contact with Walter or Andrei early during the design phase of your project. This way you can avoid a lot of frustration, by not having your project rejected after you already implemented it. +If you want to help improving Phobos, a good starting point to find meaningful tasks is the [issue tracker](https://issues.dlang.org/buglist.cgi?component=phobos&list_id=209027&product=D&resolution=---). +Furthermore the [D Wishlist](https://wiki.dlang.org/Wish_list) contains more abstract, high-level goals. -See the [CONTRIBUTING.md file](CONTRIBUTING.md). +If you want to write new modules for Phobos, we highly encourage you to stay in touch with the community early on. +Apart from receiving vital feedback and avoiding duplicate efforts, the approval of the community is needed for new additions. +In particular you should stay in contact with [Andrei](http://erdani.com/) as he can give amazing advises for your design and since he is in charge of managing Phobos he also has absolute **veto rights** against new additions, which would be quite frustrating after a lot of work. From b51deaba68049d0e2a9d903b426e395490b49490 Mon Sep 17 00:00:00 2001 From: Robert Schadek Date: Sun, 19 Jun 2016 22:35:59 +0200 Subject: [PATCH 3/4] David feedback --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0c58642a1bb..99d20a6334a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -#![D Logo](http://dlang.org/images/dlogo.png) Phobos Standard Library +![D Logo](http://dlang.org/images/dlogo.png) Phobos Standard Library +==================================================================== Phobos is the standard library that comes with the @@ -10,8 +11,8 @@ Phobos is the standard library that comes with the * [API Documentation](http://dlang.org/phobos/) * [Wiki](http://wiki.dlang.org/) -# Download - +Download +======== Phobos is packaged together with the compiler. You should @@ -23,18 +24,17 @@ there is a [description in the wiki](http://wiki.dlang.org/Building_DMD). Phobos is distributed under Boost Software Licence. See the [licence file](LICENSE_1_0.txt). -#I Want to Contribute - - -## New packages in Phobos +I Want to Contribute +==================== +New packages in Phobos +------------------------- Phobos is the standard library of the D programming language and thus tries to standardize APIs to ease development for many other programmers. Hence it's great if you want to contribute and make Phobos even better, but there are some important points that you should pay attention too. ### Blocking points for additions - In general there are some indications why something fits better to dub than to the standard library: - Low applicability / potential usage (e.g. QR Code generation, Tribune client) @@ -46,11 +46,8 @@ With dub potential users can easily use your library and if it proves to be very ### Finding good points to contribute - If you want to help improving Phobos, a good starting point to find meaningful tasks is the [issue tracker](https://issues.dlang.org/buglist.cgi?component=phobos&list_id=209027&product=D&resolution=---). Furthermore the [D Wishlist](https://wiki.dlang.org/Wish_list) contains more abstract, high-level goals. If you want to write new modules for Phobos, we highly encourage you to stay in touch with the community early on. -Apart from receiving vital feedback and avoiding duplicate efforts, the approval of the community is needed for new additions. -In particular you should stay in contact with [Andrei](http://erdani.com/) as he can give amazing advises for your design and since he is in charge of managing Phobos he also has absolute **veto rights** against new additions, which would be quite frustrating after a lot of work. - +Apart from receiving vital feedback and avoiding duplicate efforts, the approval of the community is needed for new additions. In particular, be sure to keep in touch with Andrei Alexandrescu, who manages Phobos and can **veto** new additions. From 95e0c646c179b5b8b2119cd96186d70442fd6937 Mon Sep 17 00:00:00 2001 From: Robert Schadek Date: Sun, 19 Jun 2016 22:38:26 +0200 Subject: [PATCH 4/4] Readd contributing.md hint --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 99d20a6334a..4b81b9498f6 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,5 @@ Furthermore the [D Wishlist](https://wiki.dlang.org/Wish_list) contains more abs If you want to write new modules for Phobos, we highly encourage you to stay in touch with the community early on. Apart from receiving vital feedback and avoiding duplicate efforts, the approval of the community is needed for new additions. In particular, be sure to keep in touch with Andrei Alexandrescu, who manages Phobos and can **veto** new additions. + +For more information see [CONTRIBUTING.md file](CONTRIBUTING.md).