Project contribution

[ShahanaFarooqui]

Originally asked by @mviswanathsai. Hey! I am looking to contribute, can someone guide me on where I can start?

I have cloned the repository and tried running the server, all is fine. But I am just lost as to where to start since I have not tried meddling with a code base as big. I would be very helpful if you could guide me around what kind of beginner issues I can tackle first to get a feel for the system. That way I can overcome my inertia and contribute, since I plan on being regular.

[ShahanaFarooqui]

Hey, you can start by following https://github.com/Ride-The-Lightning/RTL/blob/master/.github/docs/Contributing.md and start a new thread in discussions board if more information is needed after that.

[ShahanaFarooqui]

Steps to follow:
1: Install bitcoin.
2: Install lightning.
3: Install pre-requisites and RTL.
4: Read documentation.
5: Refer to the architectural diagram.
6: Familiarise yourself with the folder structure:

• .circleci: It contains the config file for RTL's CircleCI setup.
• .github: User and product management documentation
• backend: Compiled type script to java script code from server folder. It manages RTL's REST & WS server.
• docker & dockerfiles: Docker setup files.
• frontend: Compiled Angular to JS code from src folder.
• server: RTL server code written with nodejs, express, typescript etc.
• src:
  • app: UI code written in angular, scss, typescript for 3 implementations & shared utilities.
  • assets: Images or any other static file required for the project.
  • environments: Defined constants for separate environments.
• rtl.js file: It starts the web server.

7: Tech-stack & concepts: Depending upon the area of interest, below are some basic skills required to start:

• frontend: angular, type script, scss (preprocessor styling), angular material, shared services, rxjs, ngrx, redux (store management).
• backend: nodejs, express, promise, rest api, web sockets, synchronous vs asynchronous programming, jwt and csrf tokens.
• automated testing: karma, jasmine, webpack.
• devops: docker, circleci, github actions.

8: Refer to previously merged PRs for closed good first issue to understand the requirement and their solutions.
9: Filter some good first issue from the repo and get to work :).
10: Post a comment here if you have any follow up question.