Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Link to the dev docs + move emojis #209

Merged
merged 1 commit into from
Oct 7, 2022
Merged

Link to the dev docs + move emojis #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,7 @@ Our goal is to become the API for your entire infrastructure. Join our [communit

## Development

We love emojis in our commits. These are their meanings:

🛑 breaking 🐛 bugfix 🧹 cleanup/internals 📄 docs
✨⭐🌟🎉 smaller or larger features 🐎 race condition
🌙 MQL 🌈 visual 🍏 fix tests 🎫 auth 🦅 falcon 🐳 container
See our [Development Documentation](docs/development.md) for information on building and contributing to cnquery.

## Legal

Expand Down
20 changes: 16 additions & 4 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Development

## Prerequisites
## Building

### Prerequisites

Before building from source, be sure to install:

- [Go 1.19.0+](https://golang.org/dl/)
- [Protocol Buffers v21+](https://github.com/protocolbuffers/protobuf/releases)
-

On macOS systems with Homebrew, run: `brew install [email protected] protobuf`

## Installation from source
Expand Down Expand Up @@ -34,7 +36,7 @@ If `go` is not installed or an older version exists, follow instructions on [the
make cnquery/install
```

## Develop cnquery, provider or resources
### Develop cnquery, provider or resources

Whenever you change resources, providers, or protos, you must generate files for the compiler. To do this, make sure you have the necessary tools installed (such as protobuf):

Expand All @@ -48,4 +50,14 @@ Then, whenever you make changes, just run:
make cnquery/generate
```

This generates and updates all required files for the build. At this point you can `make cnquery/install` again as outlined above.
This generates and updates all required files for the build. At this point you can `make cnquery/install` again as outlined above.

## Contributing

### Marking PRs with Emojis

We love emojis in our commits. These are their meanings:

🛑 breaking 🐛 bugfix 🧹 cleanup/internals 📄 docs
✨⭐🌟🎉 smaller or larger features 🐎 race condition
🌙 MQL 🌈 visual 🍏 fix tests 🎫 auth 🦅 falcon 🐳 container