Onboarding process for new contributors

[git-staus]

Description

I am unable to find instructions or documentation for new users on how to start contributing to this project.

Background

I use trepan3k for my Python debugging work and am fascinated by the technology behind it. I do not have a proper background in CS nor a clear idea of how much time I can volunteer and over what time period, but I would like to try to get involved in the development of the debugger to the best of my (current) abilities.

It would be nice to know with what concepts familiarity is presupposed and what to read and so forth to understand the code base, and also perhaps what capacity you have for giving support to new contributors.

Priority

None really.

[rocky]

First and foremost, thank you for your interest. This project needs help and some love.

Since this feels like more of a discussion format, I don't think there is any one "fix" here. The things that would help you are likely not to be of use to others.

So, let's move to Discussions.

[rocky]

Description

I am unable to find instructions or documentation for new users on how to start contributing to this project.

Give me an example of some documentation somewhere that does the kind of thing you are expecting. I'll look at it and try to customize it for this project.

The problem with a request like this is that it is extremely vague because "new users" come in all kinds of shapes and sizes.

But just to level set, have you read https://python3-trepan.readthedocs.io/en/latest/?

Background

I use trepan3k for my Python debugging work and am fascinated by the technology behind it.

What exactly fascinates you? Please be very specific.

I do not have a proper background in CS nor a clear idea of how much time I can volunteer and over what time period, but I would like to try to get involved in the development of the debugger to the best of my (current) abilities.

That's funny, I don't know how much time I can volunteer, or over what time period, either. But I would like to help others get involved.

For people who are looking to get involved, I put together this wish list. Some of these things are a bit involved and may be more advanced and not necessarily for you. But at least its a start to describe some of the major areas of improvement.

[git-staus]

I am happy to hear my sentiment is appreciated! I will have a look at the pages you linked and make my request(s) more concrete.

Here is a to-do list for future me:

• Find a concrete template / example of desired onboarding documentation
  • Check general open-source how-to guides
  • Check popular Rust projects
  • See what LLMs make of the codebase
• (Re-)read the latest user documentation
• List the interesting technologies used in trepan3k
• Pick noob-friendly items from the wish list
  • Check the rest of the wiki
• Note down what aspects of the structure of the code base are unclear to me