[GitHub] [airflow] ashb commented on a change in pull request #6283: [AIRFLOW-XXXX] Google Season of Docs updates to CONTRIBUTING doc

[GitBox <gi...@apache.org>]

ashb commented on a change in pull request #6283: [AIRFLOW-XXXX] Google Season of Docs updates to CONTRIBUTING doc
URL: https://github.com/apache/airflow/pull/6283#discussion_r333479736
 
 

 ##########
 File path: CONTRIBUTING.rst
 ##########
 @@ -0,0 +1,662 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+.. contents:: :local:
+
+Contributions
+=============
+
+Contributions are welcome and are greatly appreciated! Every little bit helps,
+and credit will always be given.
+
+Report Bugs
+-----------
+
+Report bugs through `Apache
+Jira <https://issues.apache.org/jira/browse/AIRFLOW>`__.
+
+Please report relevant information and preferably code that exhibits the
+problem.
+
+Fix Bugs
+--------
+
+Look through the JIRA issues for bugs. Anything is open to whoever wants to
+implement it.
+
+Implement Features
+------------------
+
+Look through the `Apache
+JIRA <https://issues.apache.org/jira/browse/AIRFLOW>`__ for features.
+
+Any unassigned "Improvement" issue is open to whoever wants to implement it.
+
+We've created the operators, hooks, macros and executors we needed, but we've
+made sure that this part of Airflow is extensible. New operators, hooks, macros
+and executors are very welcomed!
+
+Improve Documentation
+---------------------
+
+Airflow could always use better documentation, whether as part of the official
+Airflow docs, in docstrings, ``docs/*.rst`` or even on the web as blog posts or
+articles.
+
+Submit Feedback
+---------------
+
+The best way to send feedback is to open an issue on `Apache
+JIRA <https://issues.apache.org/jira/browse/AIRFLOW>`__.
+
+If you are proposing a feature:
+
+-   Explain in detail how it would work.
+-   Keep the scope as narrow as possible to make it easier to implement.
+-   Remember that this is a volunteer-driven project, and that contributions are
+    welcome :)
+
+Documentation
+=============
+
+The latest API documentation is usually available
+`here <https://airflow.apache.org/>`__.
+
+To generate a local version:
+
+1.  Set up an Airflow development environment.
+
+2.  Install the ``doc`` extra.
+
+.. code-block:: bash
+
+    pip install -e '.[doc]'
+
+
+3.  Generate and serve the documentation as follows:
+
+.. code-block:: bash
+
+    cd docs
+    ./build.sh
+    ./start_doc_server.sh
+
+
+Pull Request Guidelines
+=======================
+
+Before you submit a pull request (PR) from your forked repo, check that it meets
+these guidelines:
+
+-   Include tests, either as doctests, unit tests, or both, to your pull
+    request.
+
+    The airflow repo uses `Travis CI <https://travis-ci.org/apache/airflow>`__ to
+    run the tests and `codecov <https://codecov.io/gh/apache/airflow>`__ to track
+    coverage. You can set up both for free on your fork (see
+    `Travis CI Testing Framework <#travis-ci-testing-framework>`__ section below).
+    It will help you make sure you do not break the build with your PR and
+    that you help increase coverage.
+
+-   `Rebase your fork <http://stackoverflow.com/a/7244456/1110993>`__, squash
+    commits, and resolve all conflicts.
+
+-   When merging PRs, wherever possible try to use **Squash and Merge** instead of **Rebase and Merge**.
+
+-   Make sure every pull request has an associated
+    `JIRA <https://issues.apache.org/jira/browse/AIRFLOW/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel>`__
+    ticket. The JIRA link should also be added to the PR description.
+
+-   Preface your commit's subject & PR title with **[AIRFLOW-XXX] COMMIT_MSG (#PR_NUMBER)** where *XXX*
 
 Review comment:
   The ` (#PR_NUMBER)` is added automaticaly by Github on merging, so we don't need this in the title or commit.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services