Skip to content

Add README and CONTRIBUTING files #1454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
2 commits merged into from
Aug 25, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Guidelines for Contributing
===========================

Welcome to the D community and thanks for your interest in contributing!

# [How to contribute pull requests?](http://wiki.dlang.org/Pull_Requests)

# More Links

* Fork [on Github](https://github.com/D-Programming-Language/phobos)
* Use our [Bugzilla bug tracker](http://d.puremagic.com/issues/)
* Follow the [Styleguide](http://dlang.org/dstyle.html)
* Participate in [our forum](http://forum.dlang.org/)
* [Review Queue](http://wiki.dlang.org/Review_Queue).


Tips for Development
--------------------

1. Build and test (e.g. the regex module)

rdmd -unittest -main std/regex.d

2. Do not forget to test your changes.
Aim for a [high code coverage of your tests](http://forum.dlang.org/thread/ki5ovr$17m1$1@digitalmars.com).

3. Do not forget the [API Documentation](http://dlang.org/phobos/).
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
![D Logo](http://dlang.org/images/dlogo.png) Phobos Runtime Library
===================================================================

Phobos is the standard runtime library that comes with the
[D Programming Language](http://dlang.org) Compiler.


* [Bugzilla bug tracker](http://d.puremagic.com/issues/)
* [Forum](http://forum.dlang.org/)
* [API Documentation](http://dlang.org/phobos/)
* [Wiki](http://wiki.dlang.org/)

Download
--------

Phobos packaged together with the compiler.
You should
[download the whole precompiled package](http://dlang.org/download.html).

To [build everything yourself](http://wiki.dlang.org/Building_DMD),
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
--------------------

Great!
See the [CONTRIBUTING.md file](CONTRIBUTING.md).