Contributing guide for gitpod contributors

Contributors
1

It would be nice to have a contributing guide for working on Gitpod similar to Set up freeCodeCamp locally.

I had to figure out the following while

  1. on what port the client is running on (Since the client and server is automatically started from gitpod.yml)
  2. Where to find the block names to test
  3. run npm run cypress:install-build-tools prior to Curriculum tests

This is clearer in Set up freeCodeCamp locally. However, the whole point of gitpod is to not deal with setting up and make contributing as easy and fast as possible.

2

would you be interested in contributing to the documentation?

I suggest starting with an issue on the repo, and then a PR with your proposed changes .

There is this part that is specifically gitpod
Work on Cypress tests (freecodecamp.org)

3

Just to mention what I did in the other thread:

4

I suggest starting with an issue on the repo, and then a PR with your proposed changes .

Sure!

Just a doubt, are there any plans to refactor the already existing docs?

The docs right now doesn’t feel beginner friendly (atleast, contributing to the curriculum)

5

Not currently, no.

For now, all we can recommend is:
a) Read the docs to the best of your ability
b) If you have questions, reach out

Perhaps the docs could benefit from a refactor. However, all the information that is currently in there is/was deemed necessary information, which is why on every issue open for contribution there is a link to the docs.

Also, whilst not necessarily easy for beginners to make use of, the docs do have a search bar which I find a lot of use out of.

6

This topic was automatically closed 182 days after the last reply. New replies are no longer allowed.