search

ganga-devs / ganga

Ganga is an easy-to-use frontend for job definition and management
GNU General Public License v3.0
100 stars 159 forks source link

Updating Developer Documentation #2317

Closed Kabiirk closed 6 months ago

Kabiirk commented 7 months ago

Hi @ Ganga Team,

While doing a POC for my GSoC'24 Proposal, I noticed that the Guide for Developers could be further enhanced for guiding new developers with detailed, step-by-step information on how to get started with development on Ganga as a python Library.

Details:

The current page looks like this: image

I plan on adding the following information before GangaObject section (tentative draft, can be modified as required):

Get started with development:

  1. Developers need to clone the repository with: git clone https://github.com/ganga-devs/ganga.git
  2. They need to go into the root of the project with : cd ganga
  3. Then, run the following command : pip install -e .[dev] This will install ganga from the repo as an editable python package with relevant runtime, coverage & test packages. Now all changes to codebase will be reflected real-time
  4. To test their changes, developers can either initiate the ganga shell with the ganga command or invoke it via a python script.

As I understand, I'll have to update docs/dev/index.rst with relevant information, test how it looks using sphinx & make PR. Let me know if that's fine. Thanks &,

Best Regards, Kabiir

egede commented 7 months ago

Looks good. Please go ahead and make a PR from a fork of the repository.

mesmith75 commented 6 months ago

Fixed by #2327