Skip to content

README.md

Latest commit

 

History

History
77 lines (44 loc) · 3.38 KB

README.md

File metadata and controls

77 lines (44 loc) · 3.38 KB

Contributing

Everyone is welcome to fork/clone the repo and contribute to improving the program.

If you would like to take a more active role in contributing to this program as a volunteer of HYF Denmark, drop an introduction in #mentorroom and a staff member will help onboard you. If you're not already a mentor, sign up your interest at www.hackyourfuture.dk/volunteer.

How to contribute

1. Sharing feedback

After taking part in a Sunday session, we strongly encourage mentors to evaluate how it went using the feedback form bookmarked in #mentorroom on Slack.

2. Suggestions and improvements

If you come across issues or ideas for improvements along the way, please create a pull request (or a GitHub issue, if you're not sure how to implement it) and share in #mentorroom for visibility and feedback.

Here is a good example of a PR made by a mentor after running a Sunday session.

You are welcome to browse the list of open issues as well, and pick any up that you think you can contribute to. All help is appreciated!

3. Questions, bigger ideas and more

If you're unsure about something in the program, or you have an idea for a bigger improvement, a new module, or something else, then please start a conversation in #mentorroom as a first step for getting answers and feedback from other mentors and staff members.

How permissions work

Permissions are managed through GitHub teams, their roles on this repo, and branch rules.

  • HYF Staff members have the admin role (to do things like changing repo settings, inviting new contributors).
  • Members of the Curriculum Crew team on GitHub have the write role (to do things like cloning, pushing branches, approving PRs - any volunteer is welcome here!).
  • One approval by anyone in Curriculum Crew or HYF Staff is required on a PR before merging is allowed.
  • Merging to main can be performed by any HYF Staff member.

Setting up and using your local environment

This project is a collection of structured README files. To maintain consistency and quality, we use a linter and suggest some recommended editor extensions.

1. Install dependencies

First, make sure you have Node.js installed.

Then, install the project dependencies using:

npm ci

This ensures a clean and reproducible setup based on the package-lock.json.

2. Set up your editor (optional but recommended)

If you are using Visual Studio Code, we have a list of recommended extensions in .vscode/extensions.json. When you open the project in VSCode, it will automatically suggest installing them to improve your development experience.

These extensions help with linting and maintaining the project’s standards.

3. Make your changes

Edit or create README files as needed. Follow the existing formatting and writing style.

4. Run the linter

Before committing your changes, make sure everything passes the linter.

To check for linting issues:

./lint

To automatically fix some issues:

./lint --fix

Tip

On Windows you cannot run bash scripts natively. In this case, open the folder in your Git Bash shell and run the commands from in there.