-
Notifications
You must be signed in to change notification settings - Fork 9
Update contributor guide #214
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ec5491e
update contributor guide
adamblanchard acfb4c7
Apply suggestion from @adamblanchard
adamblanchard 9251143
Update contributing/README.md
adamblanchard a8ee695
Update contributing/README.md
adamblanchard f775d56
Update contributing/README.md
adamblanchard e6c877e
Update contributing/README.md
adamblanchard File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,11 +2,35 @@ | |
|
|
||
| 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 as a volunteer of HYF Denmark, join #curriculum-crew on Slack to get involved. | ||
| Write in there to introduce yourself, and a staff member will onboard you and set you up with permissions. | ||
| 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 [hackyourfuture.dk/volunteer](https://hackyourfuture.dk/volunteer). | ||
|
|
||
| ## How to contribute | ||
|
|
||
| ### 1. Sharing feedback | ||
|
|
||
| After taking in a Sunday session, we strongly encourage mentors to evaluate how it went using the feedback form bookmarked in #mentorroom on Slack. | ||
adamblanchard marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### 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](https://github.com/HackYourFuture-CPH/program/issues), if you're not sure how to implement it) and share in #mentorroom for visibility and feedback. | ||
|
|
||
| You are welcome to browse the list of [open issues](https://github.com/HackYourFuture-CPH/program/issues) as well, and pick any up that you think you can contribute to. All of the help is appreciated! | ||
adamblanchard marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### 3. Questions, bigger ideas and more | ||
|
|
||
| If you're unsure about something in the program, have an idea for a bigger improvement, new module or something else, start a conversation in #mentorroom as a first step for getting answers and feedback from other mentors and staff members. | ||
adamblanchard marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## How permissions work | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Changes below here are not new, I just reordered the doc a little bit. |
||
|
|
||
| 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_ are required on a PR before merging is allowed. | ||
adamblanchard marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Merging to Main can be performed by any _HYF Staff_ member. | ||
adamblanchard marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 | ||
|
|
@@ -49,22 +73,3 @@ To automatically fix some issues: | |
|
|
||
| > [!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. | ||
|
|
||
| ### Existing issues | ||
|
|
||
| Very briefly: check the project board "Todo" column, choose one ideally near the top, assign it, clone the repo, do it, make a PR, get feedback, profit. | ||
|
|
||
| ### New ideas | ||
|
|
||
| Very briefly: Create an issue on this repo, get some feedback, and we'll prioritize them together at the next meeting. | ||
|
|
||
| Note: You are always welcome to open issues/create PRs for new ideas, whenever you like. It's an open source project. If we are currently working together towards a project goal, then it would be most helpful to prioritize tasks for that first, though. | ||
|
|
||
| ## 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!). | ||
| - Two approvals by anyone in _Curriculum Crew_ or _HYF Staff_ are required on a PR before merging is allowed. | ||
| - Merging to Main can be performed by any _HYF Staff_ member. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please ignore if not relevant: was it supposed to say "after taking part in a Sunday session..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It definitely is supposed to say that haha, will change now, thanks