Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
raisedadead committed May 21, 2024
1 parent f980595 commit 7425fd5
Showing 1 changed file with 51 additions and 5 deletions.
56 changes: 51 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,54 @@
> Our contributing docs are available here:
> <https://contribute.freecodecamp.org>.
# Contribute

:warning: **Please note**:
> docs site for all things contributions. begin your contribution journey here.
This repository is under a heavy refactoring/development phase. We are building out a brand-new experience for our contributors. Please get in touch over on our discord: https://discord.gg/freecodecamp
Welcome to the repository for freeCodeCamp.org's "Contribute" website.

Project Board: https://github.com/orgs/freeCodeCamp/projects/40
This is the place where you can find information about how to contribute to freeCodeCamp, as well as the code for the website itself. This website is built using [Astro](https://astro.build/), a modern static site generator. The goal is to make this a one-stop-shop for all things related to contributing to freeCodeCamp.

Here's a Project Board: https://github.com/orgs/freeCodeCamp/projects/40 that shows the current status of the project.

If you're looking for for opportunities to contribute to this project, look for help wanted issues in the [issues tab](https://github.com/freeCodeCamp/contribute/issues).

> [!WARNING]
> This repository is under a heavy refactoring/development phase. We are building out a brand-new experience for our contributors. Please get in touch over on our discord: https://chat.freecodecamp.org if you have any questions or need help.
## Getting Started

Your typical development workflow will look something like this:

1. **Fork** this repository to your GitHub account.
2. **Clone** your forked copy of the repository.
3. **Set upstream** to the original repository.
4. **Create a new branch** for your changes.
5. **Make your changes** to the website.
6. **Commit** your changes to your branch.
7. **Push** your branch to your forked repository.
8. **Open a Pull Request** to the original repository.

For more detailed instructions, check out this guide (_TBD_).

Build the project:

```bash
npm install -g pnpm
pnpm install
pnpm develop
```

Deploy the project (VM):

```bash
pnpm start
```

Deploy the project (Docker):

```bash
docker build -t contribute .
docker run -p 3000:3000 contribute
```

# License

Copyright © 2024 freeCodeCamp.org, licensed under the [BSD 3-Clause License](LICENSE).

0 comments on commit 7425fd5

Please sign in to comment.