aritra24 commented on code in PR #62417: URL: https://github.com/apache/airflow/pull/62417#discussion_r2848411961
########## contributing-docs/04_how_to_contribute.rst: ########## @@ -36,53 +36,115 @@ Report security issues If you want to report a security finding, please follow the `Security policy <https://github.com/apache/airflow/security/policy>`_ +Since the original text was written for Apache Airflow (which primarily uses Sphinx and +reStructuredText for documentation), converting it back to .rst ensures all the cross-references +and formatting match their existing standards. -Fix Bugs --------- - -Look through the GitHub issues for bugs. Anything is open to whoever wants to implement it. - +Here is the corrected version in reStructuredText format: Issue reporting and resolution process --------------------------------------- - -An unusual element of the Apache Airflow project is that you can open a PR to -fix an issue or make an enhancement, without needing to open an issue first. -This is intended to make it as easy as possible to contribute to the project. - -If you however feel the need to open an issue (usually a bug or feature request) -consider starting with a `GitHub Discussion <https://github.com/apache/airflow/discussions>`_ instead. -In the vast majority of cases discussions are better than issues - you should only open -issues if you are sure you found a bug and have a reproducible case, -or when you want to raise a feature request that will not require a lot of discussion. -If you have a very important topic to discuss, start a discussion on the +====================================== + +.. note:: + **TL;DR: Quick Summary** + + * **No Issue Needed:** You can open a PR directly without opening an issue first. + * **Discussion First:** If you aren't sure about a bug or feature, start a + `GitHub Discussion <https://github.com/apache/airflow/discussions>`_ instead. + * **No Assignments:** we do **not** assign issues to non-maintainers. Please do not ask to + be assigned; simply comment "working on it" and submit your PR. + * **Parallel Work Welcome:** Multiple people can work on the same issue. We merge the best Review Comment: Do we want to actively encourage it or leave it unsaid? Don't have strong opinions but would prefer not encouraging repeat work. ########## contributing-docs/04_how_to_contribute.rst: ########## @@ -36,53 +36,111 @@ Report security issues If you want to report a security finding, please follow the `Security policy <https://github.com/apache/airflow/security/policy>`_ +Since the original text was written for Apache Airflow (which primarily uses Sphinx and +reStructuredText for documentation), converting it back to .rst ensures all the cross-references +and formatting match their existing standards. Review Comment: Looks like this was left behind by ai? -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
