gaja-group
/
server-configs-nginx
mirror of https://github.com/h5bp/server-configs-nginx
2
0
Fork 0
Code Issues Releases Wiki Activity

Update repo documentation

This commit is contained in:
Léo Colombaro 2018-11-23 13:28:12 +01:00
parent e38617e7fb
commit 8f186e9205
No known key found for this signature in database
GPG Key ID: 687B480A6D4F735F
4 changed files with 22 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/CODE_OF_CONDUCT.md vendored Normal file
View File

@ -0,0 +1 @@
Please read [Code of Conduct for H5BP](https://github.com/h5bp/html5-boilerplate/blob/master/.github/CODE_OF_CONDUCT.md)

23
CONTRIBUTING.md → .github/CONTRIBUTING.md vendored
View File

@ -1,10 +1,13 @@
# Contributing to Nginx Server Configs # Contributing to Nginx Server Configs
Please take a moment to review this document in order to make the contribution ♥ [Nginx Server Configs](https://github.com/h5bp/server-configs-nginx) and
process easy and effective for everyone involved. want to get involved? Thanks! There are plenty of ways you can help!
Following these guidelines helps to communicate that you respect the time First of all, please take a moment to review this document in order to make
of the developers managing and developing this open source project. In return, the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of
the developers managing and developing this open source project. In return,
they should reciprocate that respect in addressing your issue or assessing they should reciprocate that respect in addressing your issue or assessing
patches and features. patches and features.
@ -38,7 +41,7 @@ Guidelines for bug reports:
latest `master` or development branch in the repository. latest `master` or development branch in the repository.
3. **Isolate the problem** — ideally create a [reduced test 3. **Isolate the problem** — ideally create a [reduced test
case](https://css-tricks.com/6263-reduced-test-cases/) and a live example. case](https://css-tricks.com/reduced-test-cases/) and a live example.
A good bug report shouldn't leave others needing to chase you up for more A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is information. Please try to be as detailed as possible in your report. What is
@ -90,8 +93,8 @@ accurate comments, etc.) and any other requirements (such as test coverage).
Adhering to the following this process is the best way to get your work Adhering to the following this process is the best way to get your work
included in the project: included in the project:
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, 1. [Fork](https://help.github.com/articles/fork-a-repo) the project, clone your
and configure the remotes: fork, and configure the remotes:
```bash ```bash
# Clone your fork of the repo into the current directory # Clone your fork of the repo into the current directory
@ -119,7 +122,7 @@ included in the project:
4. Commit your changes in logical chunks. Please adhere to these [git commit 4. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
or your code is unlikely be merged into the main project. Use Git's or your code is unlikely be merged into the main project. Use Git's
[interactive rebase](https://help.github.com/articles/interactive-rebase) [interactive rebase](https://help.github.com/articles/about-git-rebase)
feature to tidy up your commits before making them public. feature to tidy up your commits before making them public.
5. Locally merge (or rebase) the upstream development branch into your topic branch: 5. Locally merge (or rebase) the upstream development branch into your topic branch:
@ -137,5 +140,5 @@ included in the project:
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description. with a clear title and description.
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to **IMPORTANT**: By submitting a patch, you agree to allow the project owners to
license your work under the same license as that used by the project. license your work under the terms specified in the [MIT License](../LICENSE.txt).

2
LICENSE.txt
View File

@ -1,4 +1,4 @@
Copyright (c) Nginx Server Configs Copyright (c) H5BP
Permission is hereby granted, free of charge, to any person obtaining a copy of Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in this software and associated documentation files (the "Software"), to deal in

13
README.md
View File

@ -13,14 +13,15 @@ the project, which makes it readily available for offline reading and provides a
useful starting point for any documentation you want to write about your project. useful starting point for any documentation you want to write about your project.
## Contributing to this project ## Contributing
Anyone and everyone is welcome to contribute, but please take a moment to review Anyone is welcome to [contribute](.github/CONTRIBUTING.md),
the [contributing guidelines](CONTRIBUTING.md). however, if you decide to get involved, please take a moment to review
the [guidelines](.github/CONTRIBUTING.md):
* [Bug reports](CONTRIBUTING.md#bugs) * [Bug reports](.github/CONTRIBUTING.md#bugs)
* [Feature requests](CONTRIBUTING.md#features) * [Feature requests](.github/CONTRIBUTING.md#features)
* [Pull requests](CONTRIBUTING.md#pull-requests) * [Pull requests](.github/CONTRIBUTING.md#pull-requests)
## Acknowledgements ## Acknowledgements