-
Notifications
You must be signed in to change notification settings - Fork 10
Contribution Guidelines
This is a guide on how to contribute to the Coding Garden Community App. In here, you will find all the information about opening issues, pull requests, and getting involved. This is a beginner friendly project and all are welcome to help! We are happy to take on any and all skills you may bring to the garden! Please take a look below at our cultivated resources and see where to start. Have fun and happy coding!
- Onboarding Videos
- Opening issues
- Documentation
- Submitting features
- Code of Conduct
- Where to get help
See the playlist of videos here to learn about Agile, Scrum, Git Workflow, Feature Branches and Code Reviews: https://www.youtube.com/playlist?list=PLM_i0obccy3voD9_8ppocb5c8cZ6ndfA9
All bug reports or feature requests are managed with GitHub Issues. If you want to submit an issue just go to https://github.com/CodingGardenCommunity/app-wiki/issues/new and fill out the template.
Additionally, opening a Trello card along-side the Github Issue will help the solution progress more efficiently.
If you are a developer and want to check out the documentation you can check it out at ????.
This next section will outline the steps you need to take to improve the app.
If you want to make an edit you first need to fork the corresponding repository. This will create your own copy of the repo at your Github namespace. Now you can clone or directly download it your machine.
After cloning your repository to your local machine you want to create a new branch
to work on. You can create a new branch with the command git checkout -b branch-name. Now you can start setting up your local environment to start
coding 🎉
Check out the README.md of the project to see how the project can be built locally.
or:
All projects are built on NodeJS. If you haven't installed NodeJS you can do so
on the official website. After this just enter the
directory of the repository with your favourite shell and type npm install (or
yarn install).
Here comes project specific description:
- Database
- Mocking
- Setting up local db
- Environment variables
- Copying .env-sample and setting values
- Other prerequisites
After those steps you can start the applications with npm run start / yarn dev / whatever.
Before creating the pull request please make sure, that all tests pass. To run
the complete test suite run npm run test / yarn test.
The tests consist of linting, unit and end2end tests.
The first checks if the code style is according to the code style guidelines. The other tests are there to check if the app behaves as expected. If the tests are failing and you don't know why, feel free to contact a project owner.
Please refer to the full Coding Garden Code of Conduct for community guideline and rules. Basically to sum it up in a phrase, please don't be a jerk. ✨
If you have a question about the product please consult the documentation, open an issue, check out the Discord or Trello board. We are happy to assist!