Update contributing guide
This commit is contained in:
parent
5ca5cff5d2
commit
b52c9b80a4
@ -14,31 +14,36 @@ with a fix.
|
||||
|
||||
## Submitting a Pull Request
|
||||
|
||||
- If applicable, update the `readme`
|
||||
- Use `npm run lint` and `npm run prettier` before committing
|
||||
- Example for a commit message
|
||||
1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/arifszn/gitprofile/issues) or [open a new one](https://github.com/arifszn/gitprofile/issues/new).
|
||||
2. Once done, [fork the repository](https://github.com/arifszn/gitprofile/fork) in your own GitHub account.
|
||||
3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
|
||||
4. Make the changes on your branch.
|
||||
5. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main repository. <br>
|
||||
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**.
|
||||
|
||||
```
|
||||
Fix type validation for typescript
|
||||
```
|
||||
## Development Workflow
|
||||
|
||||
### Developing
|
||||
|
||||
Fork, then clone the repo:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/your-username/gitprofile.git
|
||||
cd gitprofile
|
||||
```
|
||||
|
||||
Install dependencies:
|
||||
### Install dependencies
|
||||
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
|
||||
Run dev server:
|
||||
### Run dev server
|
||||
|
||||
```sh
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Linter
|
||||
|
||||
Each PR should pass the linter to be accepted. To fix lint and prettier errors, run `npm run lint:fix` and `npm run prettier:fix`.
|
||||
|
||||
### Commit Message
|
||||
|
||||
As minimal requirements, your commit message should:
|
||||
|
||||
- be capitalized
|
||||
- not finish by a dot or any other punctuation character (!,?)
|
||||
- start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message.
|
||||
e.g.: "Fix the home page button" or "Add support for dark mode"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user