archive-gh-me/log4js-node
1
0
Fork 0
mirror of https://github.com/log4js-node/log4js-node.git synced 2025-12-08 19:26:01 +00:00
Code Issues Projects Releases Wiki Activity

docs(contrib): added contributors page

Browse Source
This commit is contained in:
Gareth Jones 2017-04-17 07:51:10 +10:00
parent 860ba86c91
commit f1ea44afd4
5 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/_config.yml
View File

@ -1 +1,2 @@
theme: jekyll-theme-minimal
theme: jekyll-theme-minimal
repository: nomiddlename/log4js-node

2
docs/_layouts/default.html
View File

@ -28,6 +28,8 @@
<li><a href="layouts.html">Layouts</a></li>
<li><a href="terms.html">Terminology</a></li>
<li><a href="faq.html">FAQ</a></li>
<li><a href="contrib-guidelines.html">Want to help?</a></li>
<li><a href="contributors.html">Contributors</a></li>
</ul>
{% if site.github.is_user_page %}

8
docs/contrib-guidelines.md Normal file
View File

@ -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).

9
docs/contributors.md Normal file
View File

@ -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).
<ul>
{% for contributor in site.github.contributors %}
<li><a href="{{ contributor.html_url }}">{{ contributor.login }}</a></li>
{% endfor %}
</ul>

8
docs/index.md
View File

@ -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