]> git.r.bdr.sh - rbdr/ngx_http_office_hours_filter_module/blame - CONTRIBUTING.md
Merge branch 'feature/rbdr-nginx-module-first-approach' into 'develop'
[rbdr/ngx_http_office_hours_filter_module] / CONTRIBUTING.md
CommitLineData
5003c8ea 1# Contributing to ngx_http_office_hours_filter_module
31993a16
BB
2
3This NGINX module has the simple goal of allowing you to specify office
5003c8ea 4hours for your server and not serving anything outside those hours.
31993a16 5
5003c8ea
BB
6Any contributions are welcome especially if it works towards that goal.
7
8You can check the `README` for a list of **Further Improvements** if
9you want inspiration. Also, since I'm not great at C, any improvements
10to the code itself are also welcome!
11
12## The objective of ngx_http_office_hours_filter_module
31993a16
BB
13
14Give your web server the benefit of a regulated work schedule, and
15notify the consumers of the appropriate office hours to visit the
16website.
17
5003c8ea
BB
18Providing better ways to specify the working schedule of the server
19are in line with the objective.
31993a16
BB
20
21## How to contribute
22
23Above All: Be nice, always.
24
5003c8ea 25* Always make sure the code is properly formatted with `make format`
31993a16
BB
26* Make the PRs according to [Git Flow][gitflow]: (features go to
27 develop, hotfixes go to master)
28
29[gitflow]: https://github.com/nvie/gitflow