Skip to content

Commit

Permalink
Add NOTICE to binary package and fix some typo (#128)
Browse files Browse the repository at this point in the history
* Add NOTICE to binary package and fix some typo
* Update CONTRIBUTING.md

Signed-off-by: Gao Hongtao <hanahmily@gmail.com>
  • Loading branch information
hanahmily committed Jun 2, 2022
1 parent 313a2f4 commit 7394681
Show file tree
Hide file tree
Showing 9 changed files with 95 additions and 87 deletions.
69 changes: 36 additions & 33 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,20 @@ contributing.

## Code of Conduct

This project and everyone participating in it is governed by the Apache
software Foundation's [Code of Conduct](http://www.apache.org/foundation/policies/conduct.html).
The Apache software Foundation's [Code of Conduct](http://www.apache.org/foundation/policies/conduct.html) governs this project, and everyone participating in it.
By participating, you are expected to adhere to this code. If you are aware of unacceptable behavior, please visit the
[Reporting Guidelines page](http://www.apache.org/foundation/policies/conduct.html#reporting-guidelines)
and follow the instructions there.

## How to contribute?

Most of the contributions that we receive are code contributions, but you can
also contribute to the documentation or simply report solid bugs
also contribute to the documentation or report solid bugs
for us to fix.

## How to report a bug?

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/skywalking/issues).
* **Ensure no one did report the bug** by searching on GitHub under [Issues](https://github.com/apache/skywalking/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/skywalking/issues/new).
Be sure to include a **title and clear description**, as much relevant information as possible,
Expand All @@ -35,47 +34,51 @@ Once we've discussed your changes and you've got your code ready, make sure that

* Update the README.md with details of changes to the interface.
* Includes tests for new functionality.
* References the original issue in description, e.g. "Resolves #123".
* References the original issue in the description, e.g., "Resolves #123".
* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

## Compiling and building
Clone the source code and simply run `make` in the source directory,
this will download all necessary dependencies and run tests, lint, and build three binary files in `./bin/`, for Windows, Linux, MacOS respectively.
## Building and Testing

Clone the source code and run `make build` in the source directory,
which will build the default binary file in `<sub_project>/build/bin/`.

```shell
make build
```

Please refer to [installation](./docs/installation.md) for more details.

Test your changes before submitting them by

```shell
make
make test
```

## Linting your codes
We have some rules for the code style and please lint your codes locally before opening a pull request

We have some rules for the code style and please lint your codes locally before opening a pull request.

```shell
make lint
```

if you found some errors in the output of the above command, try `make format` to fix some obvious style issues, as for the complicated errors, please fix them manually.
If you found some errors in the output of the above command, try `make format` to fix some obvious style issues. As for the complicated errors, please correct them manually.

## Test your changes before pushing

## Checking license
The Apache Software Foundation requires every source file to contain a license header, run `make license` to check that there is license header in every source file.
We have a series of checking tests to verify your changes by

```shell
make license
```

## How to release
This section guides committers and PMC members to release SkyWalking Cloud on Kubernetes in Apache Way.

### Prerequisites
- [x] [GNU Make](https://www.gnu.org/software/make/manual/make.html) is installed
- [x] [GPG tool](https://gpgtools.org) is installed
- [x] [Add your GPG key](docs/release.md#add-your-gpg-public-key)

### Release steps
- Export the version that is to be released, `export VERSION=0.1.0 `
- Tag the latest commit that is to be released with `git tag ${VERSION}` and push the tag with `git push https://github.com/apache/skywalking-banyandb ${VERSION}`
- Verify licenses, build and sign distribution packages, simply run `make release`, distribution packages and checksums are generated
- [Upload the packages to SVN repository](docs/release.md#upload-to-apache-svn)
- [Send internal announcement](docs/release.md#make-the-internal-announcements)
- [Wait at least 48 hours for test responses](docs/release.md#wait-at-least-48-hours-for-test-responses)
- [Call for vote](docs/release.md#call-a-vote-in-dev)
- [Publish release](docs/release.md#publish-release)
make pre-push
```

Please fix any errors raised by the above command.

## Update licenses

If you import new dependencies or upgrade an existing one, trigger the licenses generator
to update the license files.

```shell
make license-dep
```
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Apache SkyWalking
Copyright 2017-2021 The Apache Software Foundation
Copyright 2017-2022 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
2 changes: 1 addition & 1 deletion api/proto/banyandb/property/v1/property.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/proto/banyandb/property/v1/property.proto
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import "banyandb/model/v1/query.proto";

// Metadata is for multi-tenant use
message Metadata {
// container is created when it recevies the first property
// container is created when it receives the first property
common.v1.Metadata container = 1;
// id identifies a property
string id = 2;
Expand Down
94 changes: 47 additions & 47 deletions api/proto/banyandb/property/v1/rpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/proto/banyandb/property/v1/rpc.proto
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ message GetResponse {
}

message ListRequest {
banyandb.common.v1.Metadata contaner = 1;
banyandb.common.v1.Metadata container = 1;
}

message ListResponse {
Expand Down
2 changes: 1 addition & 1 deletion banyand/liaison/grpc/property.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func (ps *propertyServer) Get(ctx context.Context, req *propertyv1.GetRequest) (
}, nil
}
func (ps *propertyServer) List(ctx context.Context, req *propertyv1.ListRequest) (*propertyv1.ListResponse, error) {
entities, err := ps.schemaRegistry.PropertyRegistry().ListProperty(ctx, req.GetContaner())
entities, err := ps.schemaRegistry.PropertyRegistry().ListProperty(ctx, req.GetContainer())
if err != nil {
return nil, err
}
Expand Down
5 changes: 5 additions & 0 deletions dist/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Apache SkyWalking
Copyright 2017-2022 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
4 changes: 2 additions & 2 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2332,7 +2332,7 @@ Metadata is for multi-tenant use

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| container | [banyandb.common.v1.Metadata](#banyandb-common-v1-Metadata) | | container is created when it recevies the first property |
| container | [banyandb.common.v1.Metadata](#banyandb-common-v1-Metadata) | | container is created when it receives the first property |
| id | [string](#string) | | id identifies a property |


Expand Down Expand Up @@ -2466,7 +2466,7 @@ Property stores the user defined data

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| contaner | [banyandb.common.v1.Metadata](#banyandb-common-v1-Metadata) | | |
| container | [banyandb.common.v1.Metadata](#banyandb-common-v1-Metadata) | | |



Expand Down

0 comments on commit 7394681

Please sign in to comment.