Infrastructure/pingvin-share
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2025-01-29 01:28:59 -05:00
Code Issues Activity

docs: improve contributing guideline

Browse source
This commit is contained in:
Elias Schneider 2023-02-10 14:22:32 +01:00
parent 4c6ef52a17
commit c55019f71b
No known key found for this signature in database
GPG key ID: 07E623B294202B6C
1 changed files with 32 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
CONTRIBUTING.md
View file

@ -8,62 +8,55 @@ You've found a bug, have suggestion or something else, just create an issue on G
## Submit a Pull Request ## Submit a Pull Request
Once you created a issue and you want to create a pull request, follow this guide. Before you submit the pull request for review please ensure that
Branch naming convention is as following - The pull request naming follows the [Conventional Commits specification](https://www.conventionalcommits.org):
`TYPE-ISSUE_ID-DESCRIPTION` `<type>[optional scope]: <description>`
example: example:
```
feat(share): add password protection
```
When `TYPE` can be:
- **feat** - is a new feature
- **doc** - documentation only changes
- **fix** - a bug fix
- **refactor** - code change that neither fixes a bug nor adds a feature
- Your pull request has a detailed description
- You run `npm run format` to format the code
<details>
<summary>Don't know how to create a pull request? Learn how to create a pull request</summary>
1. Create a fork of the repository by clicking on the `Fork` button in the Pingvin Share repository
2. Clone your fork to your machine with `git clone`
``` ```
feat-69-ability-to-set-share-expiration-to-never $ git clone https://github.com/[your_username]/pingvin-share
```
When `TYPE` can be:
- **feat** - is a new feature
- **doc** - documentation only changes
- **fix** - a bug fix
- **refactor** - code change that neither fixes a bug nor adds a feature
**All PRs must include a commit message with the changes description!**
For the initial start, fork the project and use the `git clone` command to download the repository to your computer. A standard procedure for working on an issue would be to:
1. `git pull`, before creating a new branch, pull the changes from upstream. Your master needs to be up to date.
```
$ git pull
```
2. Create new branch from `main` like: `feat-69-ability-to-set-share-expiration-to-never`<br/>
```
$ git checkout -b [name_of_your_new_branch]
``` ```
3. Work - commit - repeat 3. Work - commit - repeat
4. Before you push your changes, make sure you run the linter and format the code. 4. Push changes to GitHub
```bash
npm run lint
npm run format
```
5. Push changes to GitHub
``` ```
$ git push origin [name_of_your_new_branch] $ git push origin [name_of_your_new_branch]
``` ```
6. Submit your changes for review 5. Submit your changes for review
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
7. Start a Pull Request 6. Start a Pull Request
Now submit the pull request and click on `Create pull request`. 7. Now submit the pull request and click on `Create pull request`.
8. Get a code review approval/reject 8. Get a code review approval/reject
</details>
## Setup project ## Setup project
Pingvin Share consists of a frontend and a backend. Pingvin Share consists of a frontend and a backend.