You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+33-53Lines changed: 33 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,14 +22,10 @@ We welcome various types of contributions:
22
22
23
23
Before you begin, ensure you have the following installed on your system:
24
24
25
-
-**Docker** - Required for containerized development and testing
26
-
-**Docker Compose** - Used for orchestrating multi-container setups
27
25
-**Git** - For version control
28
26
-**Ruby** - For running Rake tasks
29
-
30
-
> **Note:** All development work is done in Docker containers, so you don't need Ruby installed on your host machine, but it's helpful for running Rake tasks.
31
-
32
-
The instructions below assume you are in the locally cloned project root directory (`apm-ruby`).
27
+
-**Docker** - (Optional) Required for containerized development and testing
28
+
-**Docker Compose** - (Optional) Used for some rake tests that start the container
33
29
34
30
### Getting Started
35
31
@@ -49,7 +45,7 @@ The instructions below assume you are in the locally cloned project root directo
49
45
50
46
## Host Machine Setup
51
47
52
-
For development, you'll need a host environment capable of running Rake tasks to manage development and testing containers. We recommend using [rbenv](https://github.com/rbenv/rbenv) for Ruby version management.
48
+
We recommend using [rbenv](https://github.com/rbenv/rbenv) for Ruby version management.
The `solarwinds_apm` gem requires a Linux runtime environment. We use Ubuntu containers with all necessary tools for building, installing, and working with the project.
110
+
You can use Ubuntu containers with all necessary tools for building, installing, and working with the project.
128
111
129
112
#### Starting the Development Container
130
113
@@ -137,16 +120,10 @@ bundle exec rake docker_dev
137
120
Once inside the container, set up the environment:
138
121
139
122
```bash
140
-
# Choose and set the Ruby version (check available versions)
141
-
rbenv versions
142
-
rbenv global <some-version>
143
-
144
-
# Install project dependencies
145
-
bundle install
123
+
rbenv global <some-version># Choose and set the Ruby version (check available versions)
124
+
bundle install # Install project dependencies
146
125
```
147
126
148
-
#### Working in the Development Container
149
-
150
127
The development container provides a complete environment for:
151
128
152
129
- Building and testing the gem
@@ -160,17 +137,20 @@ All source code is mounted from your host machine, so changes are immediately re
160
137
161
138
#### Building the Gem
162
139
163
-
Build the gem within the development container:
140
+
Build the gem:
164
141
165
142
```bash
166
-
# Build the gem
167
-
bundle exec rake build_gem
143
+
bundle exec rake build_gem # Build the gem
144
+
gem install builds/solarwinds_apm-<version>.gem # Install the built gem locally
145
+
SW_APM_SERVICE_KEY=<api-token:service-name> irb -r solarwinds_apm # Test the installation by loading the gem
0 commit comments