This repository has been archived by the owner on Jan 9, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 337
/
CONTRIBUTING.md
166 lines (111 loc) · 7.11 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# Contributing
HospitalRun is made up of several repositories:
| Repository | Description | Technologies | Link to Repo-specific Contributing Guide |
| --- | --- | --- | --- |
| frontend | Frontend React appllication | [React](https://reactjs.org/), [Redux](https://react-redux.js.org/), [PouchDB](https://pouchdb.com/), [Jest](https://jestjs.io/) | [Link](https://github.com/HospitalRun/hospitalrun-frontend/blob/master/.github/CONTRIBUTING.md) |
| components | React building block components | [React](https://reactjs.org/), [TSDX](https://github.com/jaredpalmer/tsdx), [Jest](https://jestjs.io/), [Storybook](https://storybook.js.org/) | [Link](https://github.com/HospitalRun/components/blob/master/.github/CONTRIBUTING.md) |
| server | Host the service | [NodeJs](https://nodejs.org/en/), [Fastify](https://www.fastify.io/), [CouchDB](https://couchdb.apache.org/) | [Link](https://github.com/HospitalRun/hospitalrun-server/blob/master/.github/CONTRIBUTING.md) |
| core | Host core models | [Typebox](https://github.com/sinclairzx81/typebox) | [Link](https://github.com/HospitalRun/hospitalrun-core/blob/master/.github/CONTRIBUTING.md) |
Note: We use [TypeScript](https://www.typescriptlang.org/).
To get started contributing: fork the repositories you're interested in contributing to and follow each project's contributing guide to get the development environment setup. Each project can be contributed to independently of the other projects and there is no need to setup all the projects unless you want to contribute to all of them.
## Dev Tools
- [GitHub Codespace](https://github.com/codespaces)
- [Visual Studio Code](https://code.visualstudio.com/)
# HospitalRun General Contributing Guide
Repo-specific contributing guides are listed in the above table for easy access.
Also, you are encouraged to reach out to the community of contributors for questions and feedback. See you in Slack!
[](https://hospitalrun-slack.herokuapp.com)
## 1. Browse Issues
Interested in working on the HospitalRun codebase? The Issues tab in each repository is the best spot to begin looking for work. Issues with the `help wanted` label indicate that the issue is open for a contributor to work on. Looking for an aggregation of all open issues in the HospitalRun project, check this [link](https://hospitalrun.github.io/ubersicht/?showOpen=true&showClosed=false&showCommented=true&showUncommented=true&showIssues=true&showPullRequests=true&last24Hours=false&repos=null&labels=null&milestones=null&usernames=null#hospitalrun) out.
## 2. Get Assigned an Issue
To request an issue be assigned to you, leave a comment on the issue indicating you'd like to work on it! A core maintainer will then assign the issue to you, indicating that you are the one that will work on it.
Note: In order to support as many contributors as possible, we will try to assign one issue per contributor at a time.
Note: If a contributor has been assigned an issue for more than 14 days and there has been no activity, a core maintainer will leave a comment asking about the status of the issue. If there is no response in 7 days, then the issue will be unassigned and marked as `help wanted`.
## 3. Fork the Repository and Create a Branch
1. [Fork the repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
2. [Create a branch](https://help.github.com/en/desktop/contributing-to-projects/creating-a-branch-for-your-work)
## 4. Commit Changes
1. Stage all pending changes: `git add .`
2. Commit the changes: `npm run commit`
3. Push the changes: `git push`
Note: All repos use [conventional commits](https://www.conventionalcommits.org) and [semantic-release](https://github.com/semantic-release/semantic-release)
## 5. Submit a Pull Request
You can [create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) to submit changes to the source code. Please take a moment to see if your pull request is incomplete or complete:
| Pull Request is... | Description | Need to add tests? | Need to pass checks? |
| --- | --- | --- | --- |
| Incomplete | You have questions.<br>It is a partial implementation.<br>You plan to refactor later. etc. | No | No |
| Complete | It is ready for production. | Yes | Yes |
If incomplete, add 'WIP' to the beginning of the pull request title and mark the pull request as a [draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests).
Once submitted, a core maintainer will review the pull request and provide feedback.
Note: If feedback is requested and the author of the pull request does not follow up on the feedback within 7 days, a core maintainer will then complete the requested changes on behalf of the author and merge the changes in.
## Contributor License Agreement
HospitalRun is a member of the [Open JS Foundation](https://openjsf.org/).
As such, we request that all contributors sign our
[contributor license agreement (CLA)](https://openjsf.org/about/the-openjs-foundation-cla/).
For more information about CLAs, please check out Alex Russell’s excellent post,
[“Why Do I Need to Sign This?”](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
## Code of Conduct
Before contributing please read the [code of conduct](https://github.com/HospitalRun/hospitalrun/blob/master/.github/CODE_OF_CONDUCT.md)
# Monorepo Contributing Guide
## Toolchain
We recommend the use of [**nvm**](https://github.com/nvm-sh/nvm#install--update-script) for the management of different versions of Node, and [**yarn**](https://yarnpkg.com/) for a fast, reliable, and secure dependency management. We suggest to install **yarn** with `npm i -g yarn`.
## Getting Started
Use these commands to start using the monorepo. The following commands require that your GitHub account has [SSH access](https://help.github.com/en/articles/connecting-to-github-with-ssh) enabled.
```
git clone git@github.com:HospitalRun/hospitalrun.git
cd hospitalrun
git submodule update --init --recursive
yarn
yarn workspaces run build
# Do some coding then commit with
npx git-cz
```
## Pull all submodules
Use these commands to update all submodules and use the last available commit.
```
git submodule update --recursive --remote
yarn upgrade // Update all dependencies automatically
yarn update // This is similar to npm-check interactive update mode. It provides an easy way to update outdated packages.
```
## How to commit a specific package?
```
yarn commit-frontend
yarn commit-server
yarn commit-components
yarn commit-cli
yarn commit-core
yarn commit-docs
```
You must follow the following rules:
1. Commit description must always start with a capital letter.
2. Always use a scope. Here are some examples:
**Generic**
```
setting
ci
deps
readme
devops
system
core
testing
cli
release
lifecycle
```
**Monorepo specific**
```
monorepo
package
release
lifecycle
workspace
```
## Updating the monorepo structure
Use these commands to add a new package after adding a submodule.
```
git submodule update --remote
git add ./packages
yarn upgrade
npx git-cz
```