From 3e59b0805e8f7a9bd89179203a1307f5cb7fc02a Mon Sep 17 00:00:00 2001 From: felipeboffnunes Date: Thu, 16 Mar 2023 10:02:30 -0300 Subject: [PATCH 1/4] #5109 extend contributing.rst --- docs/contributing.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 6b1a41339..cbfcc3751 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -11,6 +11,19 @@ Contributing to Scrapy There are many ways to contribute to Scrapy. Here are some of them: +* Contribute to Scrapy by fixing currently available issues in the repository. + Scrapy has a list of `good first issues`_ and `help wanted issues`_ that you + can work on. These issues are a great way to get started with contributing to + Scrapy. If you're new to the codebase, you may want to focus on documentation + or testing-related issues, as they are always useful and can help you get + more familiar with the project. You can also check Scrapy's `test coverage`_ + to see which areas may benefit from more tests. + +* Participate in the `Google Summer of Code (GSoC)`_ program. Scrapy is a + mentoring organization for GSoC, and we welcome students who are interested + in contributing to Scrapy. Visit the `GSoC website`_ for more information on + how to participate. + * Blog about Scrapy. Tell the world how you're using Scrapy. This will help newcomers with more examples and will help the Scrapy project to increase its visibility. @@ -314,3 +327,8 @@ And their unit-tests are in:: .. _PEP 257: https://www.python.org/dev/peps/pep-0257/ .. _pull request: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request .. _pytest-xdist: https://github.com/pytest-dev/pytest-xdist +.. _good first issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 +.. _help wanted issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 +.. _Google Summer of Code (GSoC): https://summerofcode.withgoogle.com/ +.. _GSoC website: https://gsoc2022.zyte.com/participate +.. _test coverage: https://app.codecov.io/gh/scrapy/scrapy \ No newline at end of file From a81fb5002bec0091976af255d1c8a189f3fbf864 Mon Sep 17 00:00:00 2001 From: felipeboffnunes Date: Thu, 16 Mar 2023 10:23:06 -0300 Subject: [PATCH 2/4] adjustments, lean approach --- docs/contributing.rst | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index cbfcc3751..0b1ab74df 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -12,17 +12,7 @@ Contributing to Scrapy There are many ways to contribute to Scrapy. Here are some of them: * Contribute to Scrapy by fixing currently available issues in the repository. - Scrapy has a list of `good first issues`_ and `help wanted issues`_ that you - can work on. These issues are a great way to get started with contributing to - Scrapy. If you're new to the codebase, you may want to focus on documentation - or testing-related issues, as they are always useful and can help you get - more familiar with the project. You can also check Scrapy's `test coverage`_ - to see which areas may benefit from more tests. - -* Participate in the `Google Summer of Code (GSoC)`_ program. Scrapy is a - mentoring organization for GSoC, and we welcome students who are interested - in contributing to Scrapy. Visit the `GSoC website`_ for more information on - how to participate. + See :ref:`contributing-to-scrapy-codebase` below for more information. * Blog about Scrapy. Tell the world how you're using Scrapy. This will help newcomers with more examples and will help the Scrapy project to increase its @@ -41,6 +31,16 @@ There are many ways to contribute to Scrapy. Here are some of them: * Answer Scrapy questions at `Stack Overflow `__. +=============================== +Contributing to Scrapy codebase +=============================== + +Scrapy has a list of `good first issues`_ and `help wanted issues`_ that you +can work on. These issues are a great way to get started with contributing to +Scrapy. If you're new to the codebase, you may want to focus on documentation +or testing-related issues, as they are always useful and can help you get +more familiar with the project. You can also check Scrapy's `test coverage`_ +to see which areas may benefit from more tests. Reporting bugs ============== @@ -329,6 +329,4 @@ And their unit-tests are in:: .. _pytest-xdist: https://github.com/pytest-dev/pytest-xdist .. _good first issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 .. _help wanted issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 -.. _Google Summer of Code (GSoC): https://summerofcode.withgoogle.com/ -.. _GSoC website: https://gsoc2022.zyte.com/participate .. _test coverage: https://app.codecov.io/gh/scrapy/scrapy \ No newline at end of file From 7bcbfabdbc87aaf53af3216f48bc8524f2453a4d Mon Sep 17 00:00:00 2001 From: felipeboffnunes Date: Thu, 16 Mar 2023 10:28:12 -0300 Subject: [PATCH 3/4] forgot header bind --- docs/contributing.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 0b1ab74df..823979d0b 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -31,6 +31,8 @@ There are many ways to contribute to Scrapy. Here are some of them: * Answer Scrapy questions at `Stack Overflow `__. +.. _contributing-to-scrapy-codebase: + =============================== Contributing to Scrapy codebase =============================== From af730df83c74296ec2e831417278b21952b098f7 Mon Sep 17 00:00:00 2001 From: Felipe Boff Nunes Date: Mon, 27 Mar 2023 08:40:17 -0300 Subject: [PATCH 4/4] adjustments --- docs/contributing.rst | 31 +++++++++++-------------------- 1 file changed, 11 insertions(+), 20 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 823979d0b..eef92e148 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -11,13 +11,6 @@ Contributing to Scrapy There are many ways to contribute to Scrapy. Here are some of them: -* Contribute to Scrapy by fixing currently available issues in the repository. - See :ref:`contributing-to-scrapy-codebase` below for more information. - -* Blog about Scrapy. Tell the world how you're using Scrapy. This will help - newcomers with more examples and will help the Scrapy project to increase its - visibility. - * Report bugs and request features in the `issue tracker`_, trying to follow the guidelines detailed in `Reporting bugs`_ below. @@ -25,25 +18,16 @@ There are many ways to contribute to Scrapy. Here are some of them: :ref:`writing-patches` and `Submitting patches`_ below for details on how to write and submit a patch. +* Blog about Scrapy. Tell the world how you're using Scrapy. This will help + newcomers with more examples and will help the Scrapy project to increase its + visibility. + * Join the `Scrapy subreddit`_ and share your ideas on how to improve Scrapy. We're always open to suggestions. * Answer Scrapy questions at `Stack Overflow `__. -.. _contributing-to-scrapy-codebase: - -=============================== -Contributing to Scrapy codebase -=============================== - -Scrapy has a list of `good first issues`_ and `help wanted issues`_ that you -can work on. These issues are a great way to get started with contributing to -Scrapy. If you're new to the codebase, you may want to focus on documentation -or testing-related issues, as they are always useful and can help you get -more familiar with the project. You can also check Scrapy's `test coverage`_ -to see which areas may benefit from more tests. - Reporting bugs ============== @@ -95,6 +79,13 @@ guidelines when you're going to report a new bug. Writing patches =============== +Scrapy has a list of `good first issues`_ and `help wanted issues`_ that you +can work on. These issues are a great way to get started with contributing to +Scrapy. If you're new to the codebase, you may want to focus on documentation +or testing-related issues, as they are always useful and can help you get +more familiar with the project. You can also check Scrapy's `test coverage`_ +to see which areas may benefit from more tests. + The better a patch is written, the higher the chances that it'll get accepted and the sooner it will be merged. Well-written patches should: