Skip to content

Commit

Permalink
docs: update contributing and readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sounmind
sounmind committed Jun 23, 2024
1 parent da2eb70 commit fb22748
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
17 changes: 10 additions & 7 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,15 @@ We appreciate your time and effort. Here are some guidelines to help you get sta

## How to Contribute

1. Add an item(draft) to the [Backlog](https://github.com/orgs/DaleStudy/projects/2/views/1) in the [Project](https://github.com/orgs/DaleStudy/projects/2).
2. Convert item(draft) to an Issue with click "Convert to issue" button.
3. Create a branch through the Issue.
4. Make a PR after you've pushed your code changes (Don't forget to link your PR to the Issue you created earlier).
5. After a code review and receiving at least one approval, merge the changes into the main branch.
6. The code merged into the main branch will be immediately released through GitHub Pages.
We manage our project using GitHub Projects. You can find the project [here](https://github.com/orgs/DaleStudy/projects/2). The team holds a weekly meeting to discuss the previous week's progress and plan for the upcoming week.

1. Create ticket(item or draft in Backlog)s together in regular meetings.
2. Assign yourself to a ticket on [the Kanban board](https://github.com/orgs/DaleStudy/projects/2/views/2).
3. Convert item to an Issue with click "Convert to issue" button.
4. Create a branch through the Issue.
5. Make a PR after you've pushed your code changes (Don't forget to link your PR to the Issue you created earlier).
6. After a code review and receiving at least one approval, merge the changes into the main branch.
7. The code merged into the main branch will be immediately released through GitHub Pages.

## Style Guides

Expand All @@ -37,4 +40,4 @@ We appreciate your time and effort. Here are some guidelines to help you get sta

## Community

- Join our [Discord](https://discord.gg/43UkheRV) to connect with other contributors.
- Join our [Discord](https://discord.gg/6TwzdnW6ze) to connect with other contributors.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@
- HTML, CSS, Javascript
- [Web Components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components)
- Github Pages

## Contribution

Please refer to [our contribution guide](./CONTRIBUTING.md).

0 comments on commit fb22748

Please sign in to comment.