From 8eca14f331cf22e1f1b28e2542a0966f480845f9 Mon Sep 17 00:00:00 2001 From: Alex Vanin Date: Wed, 7 Jun 2023 13:01:44 +0300 Subject: [PATCH] [#1] Update CONTRIBUTING Signed-off-by: Alex Vanin --- CONTRIBUTING.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3ae1f1..fb57514 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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-dev-env/issues) and - [pull requests](https://github.com/TrueCloudLab/frostfs-dev-env/pulls) for existing +- Check the open [issues](https://git.frostfs.info/TrueCloudLab/frostfs-dev-env/issues) and + [pull requests](https://git.frostfs.info/TrueCloudLab/frostfs-dev-env/pulls) for existing discussions. - Open an issue first, to discuss a new feature or enhancement. @@ -25,19 +25,19 @@ Start by forking the `frostfs-dev-env` 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 node upstream](https://github.com/TrueCloudLab/frostfs-dev-env/fork) source +### Set up your git repository +Fork [FrostFS node upstream](https://git.frostfs.info/repo/fork/24) 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-dev-env +$ git clone https://git.frostfs.info//frostfs-dev-env.git ``` ### Set up git remote as ``upstream`` ```sh $ cd frostfs-dev-env -$ git remote add upstream https://github.com/TrueCloudLab/frostfs-dev-env +$ git remote add upstream https://git.frostfs.info/TrueCloudLab/frostfs-dev-env.git $ git fetch upstream $ git merge upstream/master ... @@ -55,8 +55,7 @@ $ git checkout -b feature/123-something_awesome ### Test your changes After your code changes, make sure -- To add test cases for the new code. -- To run `make lint` +- To run `make up` to check dev-env is not broken. - To squash your commits into a single commit or a series of logically separated commits run `git rebase -i`. It's okay to force update your pull request. @@ -86,8 +85,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.