]> git.r.bdr.sh - rbdr/ngx_http_office_hours_filter_module/commitdiff
Update the contributing guide
authorBen Beltran <redacted>
Fri, 28 Dec 2018 20:05:03 +0000 (13:05 -0700)
committerBen Beltran <redacted>
Fri, 28 Dec 2018 20:05:03 +0000 (13:05 -0700)
CONTRIBUTING.md

index 3e3d41b3f0140800b97b05824bc52008a6a64c2f..0cbd8518037fd1eece2065256513d9db14dec827 100644 (file)
@@ -1,24 +1,28 @@
-# Contributing to ngx_office_hours
+# Contributing to ngx_http_office_hours_filter_module
 
 This NGINX module has the simple goal of allowing you to specify office
-hours for your server, any contributions are welcome especially if it
-makes that goal easier to achieve.
+hours for your server and not serving anything outside those hours.
 
-## The objective of Sumo
+Any contributions are welcome especially if it works towards that goal.
+
+You can check the `README` for a list of **Further Improvements** if
+you want inspiration. Also, since I'm not great at C, any improvements
+to the code itself are also welcome!
+
+## The objective of ngx_http_office_hours_filter_module
 
 Give your web server the benefit of a regulated work schedule, and
 notify the consumers of the appropriate office hours to visit the
 website.
 
-A big factor currently not considered is to serve the site in the time
-zone of the visitor, currently it is UTC only.
+Providing better ways to specify the working schedule of the server
+are in line with the objective.
 
 ## How to contribute
 
 Above All: Be nice, always.
 
-* Ensure the style checker shows no warnings or errors
-* Don't break the CI
+* Always make sure the code is properly formatted with `make format`
 * Make the PRs according to [Git Flow][gitflow]: (features go to
   develop, hotfixes go to master)