Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Developer Documentation #2317

Closed
Kabiirk opened this issue Apr 7, 2024 · 2 comments
Closed

Updating Developer Documentation #2317

Kabiirk opened this issue Apr 7, 2024 · 2 comments

Comments

@Kabiirk
Copy link
Contributor

Kabiirk commented Apr 7, 2024

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
Copy link
Member

egede commented Apr 10, 2024

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

@mesmith75
Copy link
Contributor

Fixed by #2327

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants