TrueCloudLab/frostfs-rest-gw
Archived
15
0
Fork 6
Code Issues 2 Pull requests 1 Projects Releases Activity Actions

[#2] Update CONTRIBUTING

Browse source 
Signed-off-by: Alex Vanin <a.vanin@yadro.com>
This commit is contained in:
Alexey Vanin 2023-06-28 17:38:25 +03:00
parent fd25f939c5
commit e03b907565
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
CONTRIBUTING.md
View file

@ -3,8 +3,8 @@
First, thank you for contributing! We love and encourage pull requests from
everyone. Please follow the guidelines:
- Check the open [issues](https://github.com/TrueCloudLab/frostfs-rest-gw/issues) and
[pull requests](https://github.com/TrueCloudLab/frostfs-rest-gw/pulls) for existing
- Check the open [issues](https://git.frostfs.info/TrueCloudLab/frostfs-rest-gw/issues) and
[pull requests](https://git.frostfs.info/TrueCloudLab/frostfs-rest-gw/pulls) for existing
discussions.
- Open an issue first, to discuss a new feature or enhancement.
@ -27,19 +27,20 @@ Start by forking the `frostfs-rest-gw` repository, make changes in a branch and
send a pull request. We encourage pull requests to discuss code changes. Here
are the steps in details:
### Set up your GitHub Repository
Fork [FrostFS REST Gateway upstream](https://github.com/TrueCloudLab/frostfs-rest-gw/fork) source
repository to your own personal repository. Copy the URL of your fork (you will
need it for the `git clone` command below).
### Set up your git repository
Fork [FrostFS REST Gateway
upstream](https://git.frostfs.info/repo/fork/6) source repository
to your own personal repository. Copy the URL of your fork (you will need it for
the `git clone` command below).
```sh
$ git clone https://github.com/TrueCloudLab/frostfs-rest-gw
$ git clone https://git.frostfs.info/<username>/frostfs-rest-gw.git
```
### Set up git remote as ``upstream``
```sh
$ cd frostfs-rest-gw
$ git remote add upstream https://github.com/TrueCloudLab/frostfs-rest-gw
$ git remote add upstream https://git.frostfs.info/TrueCloudLab/frostfs-rest-gw.git
$ git fetch upstream
$ git merge upstream/master
...
@ -89,8 +90,8 @@ $ git push origin feature/123-something_awesome
```
### Create a Pull Request
Pull requests can be created via GitHub. Refer to [this
document](https://help.github.com/articles/creating-a-pull-request/) for
Pull requests can be created via Forgejo. Refer to [this
document](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/) for
detailed steps on how to create a pull request. After a Pull Request gets peer
reviewed and approved, it will be merged.