diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d01cc5b --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +Please read [Code of Conduct for H5BP](https://github.com/h5bp/html5-boilerplate/blob/master/.github/CODE_OF_CONDUCT.md) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 86% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index 86b42c9..c0901bc 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,10 +1,13 @@ # Contributing to Nginx Server Configs -Please take a moment to review this document in order to make the contribution -process easy and effective for everyone involved. +♥ [Nginx Server Configs](https://github.com/h5bp/server-configs-nginx) and +want to get involved? Thanks! There are plenty of ways you can help! -Following these guidelines helps to communicate that you respect the time -of the developers managing and developing this open source project. In return, +First of all, please take a moment to review this document in order to make +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 patches and features. @@ -38,7 +41,7 @@ Guidelines for bug reports: latest `master` or development branch in the repository. 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 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 included in the project: -1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork, - and configure the remotes: +1. [Fork](https://help.github.com/articles/fork-a-repo) the project, clone your + fork, and configure the remotes: ```bash # 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 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 - [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. 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/) with a clear title and description. -**IMPORTANT**: By submitting a patch, you agree to allow the project owner to -license your work under the same license as that used by the project. +**IMPORTANT**: By submitting a patch, you agree to allow the project owners to +license your work under the terms specified in the [MIT License](../LICENSE.txt). diff --git a/LICENSE.txt b/LICENSE.txt index 126c27d..ac8f637 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -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 this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index 8746f8a..1507607 100644 --- a/README.md +++ b/README.md @@ -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. -## Contributing to this project +## Contributing -Anyone and everyone is welcome to contribute, but please take a moment to review -the [contributing guidelines](CONTRIBUTING.md). +Anyone is welcome to [contribute](.github/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) -* [Feature requests](CONTRIBUTING.md#features) -* [Pull requests](CONTRIBUTING.md#pull-requests) +* [Bug reports](.github/CONTRIBUTING.md#bugs) +* [Feature requests](.github/CONTRIBUTING.md#features) +* [Pull requests](.github/CONTRIBUTING.md#pull-requests) ## Acknowledgements