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.

Sign up for GitHub

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

Jump to bottom

Oss contributions #64

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Oss contributions #64

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c371327
update README with links to resources
kinkadesOSU Jun 8, 2022
2ed3e35
add hyperlinks
kinkadesOSU Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,33 @@ Now it is time to share the hard work with the rest of the community. WeClimb.it
The code of this repository is up and running on [WeClimb.it](https://www.weclimb.it).

---

We follow a monorepo approach, if you want to know more about the code, feel free to browse the folders.
Please note that we use GIT submodules for the frontend, backend and design. Some of them might be private; in such a case, if you want to contribute to that submodules, feel free to drop a message and get in touch with us.

# Heading 1 Contributing to WeClimb
Please follow the following guidelines when contributing to our project, WeClimb.it. These have been sourced together by reviewing the current code. As such, they are guidelines rather than rules. If you feel a guideline is restrictive for what you want to change, let us know so we can amend this doc!
## Heading 3 Code of Conduct
[Here](https://github.com/WeClimb-it/weclimb.it/blob/master/CODE_OF_CONDUCT.md) is a link to our code of conduct. Please reach out if you have questions or think something is in violation
Important Things to Know before Contributing
We follow a “monorepo” approach. This simply means each project is separate and easily contributed to.
Some of these repos may be private. If that is the case, message us and we can get you access
This project contains [Node](https://nodejs.org/en/docs/), [Typescript](https://www.typescriptlang.org/docs/), and [Angular](https://angular.io/docs) and all their conventional coding practices. Please refer to their documentation if you have questions.
## Heading 2 How to Contribute
## Heading 3 Initial Set Up
To clone the repo you can use the following command:
`git clone --recurse-submodules https://github.com/WeClimb-it/weclimb.it.git`

In case you want git pull to also fetch a submodule and run submodule update, you can use this configuration:
`git config --global submodule.recurse true`
## Heading 3 Bug Reporting
We track bugs with Github’s issues feature. You may submit a bug via that process if you find one. Make sure the issue report:
* List Has a descriptive name
* List Contains steps to reproduce the bug, including steps that you followed to resolve it
* List This can be augmented by screenshots or other visuals
## Heading 3 Pull Requests
Finally, we love outside support for this project. If you want to contribute to the project:
* List Find an issue that you feel like you can solve (or suggest your own)
* List Make sure your code follows the standard conventions for the language you’re
using. Include comments to help others understand your thinking
* List Add comments to the pull request so we know what you changed
We follow a monorepo approach, if you want to know more about the code, feel free to browse the folders.
Please note that we use GIT submodules for the frontend, backend and design. Some of them might be private; in such a case, if you want to contribute to that submodules, feel free to drop a message and get in touch with us.