server/beego
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Updated CONTRIBUTING.md to fix some grammatical errors (#5416)

Browse Source 
Co-authored-by: Arthur Kalikiti <arthur.kalikiti@infratel.co.zm>
This commit is contained in:
Arthur Kalikiti 2023-09-18 09:28:20 +02:00 committed by GitHub
parent e465249ef6
commit 486fbbf2d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -1,4 +1,5 @@
# developing # developing
- [refactor: CONTRIBUTING.md file grammatical improvements](https://github.com/beego/beego/issues/5411)
- [fix: refactor Count method](https://github.com/beego/beego/pull/5300) - [fix: refactor Count method](https://github.com/beego/beego/pull/5300)
- [support db_type in ddl ](https://github.com/beego/beego/pull/5404) - [support db_type in ddl ](https://github.com/beego/beego/pull/5404)
- [orm: PostgreSQL change auto to bigserial](https://github.com/beego/beego/pull/5415) - [orm: PostgreSQL change auto to bigserial](https://github.com/beego/beego/pull/5415)

37
CONTRIBUTING.md
View File

@ -1,15 +1,15 @@
# Contributing to beego # Contributing to beego
beego is an open source project. Beego is an open-source project.
It is the work of hundreds of contributors. We appreciate your help! It is the work of hundreds of contributors. And you could be among them, so we appreciate your help!
Here are instructions to get you started. They are probably not perfect, please let us know if anything feels wrong or Here are instructions to get you started. They are probably not perfect, so please let us know if anything feels wrong or
incomplete. incomplete.
## Prepare environment ## Prepare environment
Firstly, install some tools. Execute those commands **outside** the project. Or those command will modify go.mod file. Firstly, you need to install some tools. Execute the commands below **outside** the project. Otherwise, this action will modify the go.mod file.
```shell script ```shell script
go get -u golang.org/x/tools/cmd/goimports go get -u golang.org/x/tools/cmd/goimports
@ -17,7 +17,7 @@ go get -u golang.org/x/tools/cmd/goimports
go get -u github.com/gordonklaus/ineffassign go get -u github.com/gordonklaus/ineffassign
``` ```
Put those lines into your pre-commit githook script: Put the lines below in your pre-commit git hook script:
```shell script ```shell script
goimports -w -format-only ./ goimports -w -format-only ./
@ -29,17 +29,17 @@ staticcheck -show-ignored -checks "-ST1017,-U1000,-ST1005,-S1034,-S1012,-SA4006,
## Prepare middleware ## Prepare middleware
Beego uses many middlewares, including MySQL, Redis, SSDB and so on. Beego uses many middlewares, including MySQL, Redis, SSDB amongs't others.
We provide docker compose file to start all middlewares. We provide a docker-compose file to start all middlewares.
You can run: You can run the following command to start all middlewares:
```shell script ```shell script
docker-compose -f scripts/test_docker_compose.yaml up -d docker-compose -f scripts/test_docker_compose.yaml up -d
``` ```
Unit tests read addresses from environment, here is an example: Unit tests read addresses from environmental variables, you can set them up as shown in the example below:
```shell script ```shell script
export ORM_DRIVER=mysql export ORM_DRIVER=mysql
@ -53,23 +53,18 @@ export SSDB_ADDR="192.168.0.105:8888"
### Pull requests ### Pull requests
First, beego follow the gitflow. So please send you pull request to **develop** branch. We will close the pull Beego follows the gitflow. And as such, please submit your pull request to the **develop** branch. We will close the pull request by merging it into the master branch.
request to master branch.
By the way, please don't forget update the `CHANGELOG.md` before you send pull request. **NOTE:** Don't forget to update the `CHANGELOG.md` file by adding the changes made under the **developing** section.
You can just add your pull request following 'developing' section in `CHANGELOG.md`.
We'll release them in the next Beego version. We'll release them in the next Beego version.
We are always happy to receive pull requests, and do our best to review them as fast as possible. Not sure if that typo We are always happy to receive pull requests, and do our best to review them as fast as possible. Not sure if that typo is worth a pull request? Just do it! We will appreciate it.
is worth a pull request? Do it! We will appreciate it.
Don't forget to rebase your commits! Don't forget to rebase your commits!
If your pull request is not accepted on the first try, don't be discouraged! Sometimes we can make a mistake, please do If your pull request is rejected, dont be discouraged. Sometimes we make mistakes. You can provide us with more context by explaining your issue as clearly as possible.
more explaining for us. We will appreciate it.
We're trying very hard to keep beego simple and fast. We don't want it to do everything for everybody. This means that In our pursuit of maintaining Beego's simplicity and speed, we might not accept some feature requests. We don't want it to do everything for everybody. For this reason, we might decide against incorporating a new feature. However, we will provide guidance on achieving the same thing using a different approach
we might decide against incorporating a new feature. But we will give you some advice on how to do it in other way.
### Create issues ### Create issues
@ -86,6 +81,6 @@ Also when filing an issue, make sure to answer these five questions:
### but check existing issues and docs first! ### but check existing issues and docs first!
Please take a moment to check that an issue doesn't already exist documenting your bug report or improvement proposal. Take a moment to check that an issue documenting your bug report or improvement proposal doesn't already exist.
If it does, it never hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common If it does, it doesn't hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common
problems and requests. problems and requests.