mik-laj opened a new pull request #4827: [AIRFLOW-XXX] Add contribute guide, 
updating to docs
URL: https://github.com/apache/airflow/pull/4827
 
 
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
     - https://issues.apache.org/jira/browse/AIRFLOW-XXX
   
   ### Description
   
   Preview: http://wiggly-ring.surge.sh/contributing.html
   
   This change adds two new pages to the documentation.
   * Developer’s Guide
   * Updating 
   
   Reasons for making changes:
   * creates space for another document that was discussed on the dev list
   
https://lists.apache.org/thread.html/af7637c61acbb877dc68f337b633b2c34a43f91a2ebafc61208daf0c@%3Cdev.airflow.apache.org%3E
   * creates one source of knowledge. The user has all the materials available 
in one place.
   * historical versions of documents become available in the compiled version 
- https://readthedocs.org/projects/airflow/
   * unifies the documentation format in repo. Previously some files were in 
txt, others in markdown.   
   * linking between documents was difficult. It is now possible to refer to 
this document from the documentation. See: 
http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged
   
   Other changes: 
   * Some files lacked a license header.
   * Rename CHANGELOG.txt to CHANGELOG.rst. The content of the file pointed to 
a different format than the file name.
   
   CC: @potiuk @fenglu-g 
   
   ### Tests
   
   - [ ] My PR adds the following unit tests __OR__ does not need testing for 
this extremely good reason:
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines, and I 
have squashed multiple commits if they address the same issue. In addition, my 
commits follow the guidelines from "[How to write a good git commit 
message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   No applicable
   
   ### Code Quality
   
   No applicable

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to