diff --git a/docs/_config.yml b/docs/_config.yml index 2f7efbe..8ce87bf 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,2 @@ -theme: jekyll-theme-minimal \ No newline at end of file +theme: jekyll-theme-minimal +repository: nomiddlename/log4js-node diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 2ee6fa9..e16f129 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -28,6 +28,8 @@
  • Layouts
  • Terminology
  • FAQ
  • +
  • Want to help?
  • +
  • Contributors
  • {% if site.github.is_user_page %} diff --git a/docs/contrib-guidelines.md b/docs/contrib-guidelines.md new file mode 100644 index 0000000..07f8c9d --- /dev/null +++ b/docs/contrib-guidelines.md @@ -0,0 +1,8 @@ +# Want to help? + +I love pull requests, and I need all the help I can get. However, there are a few rules to follow if you want a better chance of having your pull request merged: + +* Fork the repo, make a feature branch just for your changes +* On the branch, only commit changes for the feature you're adding. Each pull request should concentrate on a single change - don't mix multiple features. +* Your feature should be covered by tests. Run the tests with npm test. This is very important - without tests, your feature may be broken by subsequent changes and I may never know. Plus it's always nice to know that your changes work :-) +* Don't bump the npm version - yours may not be the only feature that makes it into a version, and you don't know when your pull request may get merged (the version may have changed by then). diff --git a/docs/contributors.md b/docs/contributors.md new file mode 100644 index 0000000..ab719ce --- /dev/null +++ b/docs/contributors.md @@ -0,0 +1,9 @@ +# Contributors + +Many people have helped make log4js what it is today. Here's a list of everyone who has contributed to the code. There are lots of people who've helped by submitting bug reports or pull requests that I haven't merged, but I have used their ideas to implement a different way. Thanks to you all. This library also owes a huge amount to the [original log4js project](https://github.com/stritti/log4js). If you'd like to help out, take a look at the [contributor guidelines](contrib-guidelines.md). + + diff --git a/docs/index.md b/docs/index.md index 08f2ac8..43c269b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -32,14 +32,6 @@ var logger = log4js.getLogger(); logger.debug("Some debug messages"); ``` -## Documentation - -* [Terminology](terms.md) -* [Log4js API](api.md) -* [Appenders](appenders.md) -* [Layouts](layouts.md) -* [Frequently Asked Questions](faq.md) - ## License The original log4js was distributed under the Apache 2.0 License, and so is this. I've tried to