You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
I plan on adding the following information before GangaObject section (tentative draft, can be modified as required):
Get started with development:
Developers need to clone the repository with: git clone https://github.com/ganga-devs/ganga.git
They need to go into the root of the project with : cd ganga
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
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
The text was updated successfully, but these errors were encountered:
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:
I plan on adding the following information before
GangaObject
section (tentative draft, can be modified as required):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
The text was updated successfully, but these errors were encountered: