pytorch / ignite

High-level library to help with training and evaluating neural networks in PyTorch flexibly and transparently.
https://pytorch-ignite.ai
BSD 3-Clause "New" or "Revised" License
4.51k stars 609 forks source link

Add materials on how to setup dev env in CONTRIBUTING guide #1395

Closed vfdev-5 closed 3 years ago

vfdev-5 commented 3 years ago

🚀 Feature

It would be helpful for the beginners to understand how to setup its development environment and start working on issues. For example, we can base on installing miniconda and setting up a new conda environment.

Idea is to add a small guide here (before Installation section) and provide a link on a complete guide.

Let's also add links to :

Another point to add is a sentence to prevent modifications of .gitignore as it was decided from the beginning to use locally .git/info/exclude to exclude custom files like: .idea, .vscode etc.

For Hacktoberfest contributors, feel free to ask questions for details if any and say that you would like to tackle the issue. Please, take a look at CONTRIBUTING guide.

vfdev-5 commented 3 years ago

@BanzaiTokyo would you like to tackle this one :)

BanzaiTokyo commented 3 years ago

@vfdev-5 This is definitely doable, but looks time consuming. At the moment I have some other urgent things I need to finish. So it looks like something I could look into in a month or so.

vfdev-5 commented 3 years ago

@BanzaiTokyo OK, I see. Let's see if it is still open then you can give it a go as soon as it is possible for you. Otherwise, I can assign it to anyone else :)

BanzaiTokyo commented 3 years ago

sure @vfdev-5 !

fco-dv commented 3 years ago

@vfdev-5 I can give it a try!