Welcome Achyut! Glad you're interested in joining us next GSoC :)

Sadly our whole workflow isn't documented consistently, but looking at 
Kivy's I see they are rather similar. Only differences I notice is that we 
don't have precommit git hooks, we aren't enforcing pep8 compliance (though 
we usually tell developers to follow pep8 if they deviate too much from 
it), and we usually prefer rebasing Scrapy's master into the pull requests 
instead of merging it (that'll be "git pull --rebase scrapy master" 
following Kivy's workflow).

Then we have our installation docs here: Installation guide 
<http://scrapy.readthedocs.org/en/latest/intro/install.html>, but we don't 
mention how to install Scrapy for development. Usually we follow the steps 
for our specific platform, clone the repo, and then install Scrapy inside a 
virtualenv using "pip install -e .".

Running tests and writing them is covered in Contributing 
<http://doc.scrapy.org/en/master/contributing.html>, though we could 
probably add how to test for specific virtualenvs. Running "tox" on its own 
will run all the envs, but you can test some of them particularly (for 
example, we have "py27", "py34", "docs", which you can run with "tox -e 
<env1>,<env2>"). This comes handy to shorten the time running tests, but it 
goes without saying that all envs should pass to even consider merging a 
pull request.

Another thing not present in readthedocs is a dedicated section to 
submitting patches for our documentation, though we have a guide inside the 
repo here: docs/README 
<https://github.com/scrapy/scrapy/blob/master/docs/README>.

Lastly, if you plan on improving the Python 3 support for Scrapy, there's 
an additional guide in the wiki: Python-3-Porting 
<https://github.com/scrapy/scrapy/wiki/Python-3-Porting>.

It's truly inconvenient to have all that documentation scattered across 
different places, I hope you find your way through. If you want to submit a 
pull request improving the docs (I'd probably stick to extending/fixing the 
Contributing section instead of the Installation one), it'd be more than 
welcome!


On Thursday, September 17, 2015 at 7:48:58 AM UTC-3, Achyut Rastogi wrote:
>
> Hello,
> I am Achyut Rastogi (ImmoveableOne on IRC), I am here for GSoC 2016. I 
> know its a bit early and all but I feel this is a place where I can develop 
> my skills. I have worked on a bug or two before at Kivy and they follow 
> this 
> <http://www.google.com/url?q=http%3A%2F%2Fkivy.org%2Fdocs%2Fcontribute.html%23code-contributions&sa=D&sntz=1&usg=AFQjCNFnXxx7qupjj-w042buPM1tQ-82lQ>
>  
> particular work-flow. Its followed by a detailed description of how to 
> setup the dev-environ and all. I tried to find the same for scrapy and, I 
> found this 
> <http://doc.scrapy.org/en/master/contributing.html#scrapy-contrib> but 
> there is no definite work-flow defined, so I wanted to know if such a 
> document exists and I have not found it or none exist. If there is a 
> general work-flow I am unaware of please tell(as in what the developers 
> follow), if you would like I could define a work-flow just like that of 
> Kivy and submit a pull request for that here 
> <https://www.google.com/url?q=https%3A%2F%2Fgithub.com%2Fscrapy%2Fscrapy%2Fblob%2Fmaster%2Fdocs%2Fintro%2Finstall.rst&sa=D&sntz=1&usg=AFQjCNF-igjSiRwQwvtQkVyoMQuIuuqxfQ>
> .
>
> Thank you :)
>

-- 
You received this message because you are subscribed to the Google Groups 
"scrapy-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/scrapy-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to