Skip to content

Commit bcde788

Browse files
authored
Merge pull request #1 from newrelic/contributing_info
Add contributing information
2 parents e5d7614 + a42636c commit bcde788

File tree

2 files changed

+80
-1
lines changed

2 files changed

+80
-1
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Guidelines for Contributing Code
2+
3+
At New Relic we welcome community code contributions, and have taken effort to
4+
make this process easy for both contributors and our development team.
5+
6+
## Branches
7+
8+
The head of master will generally have New Relic's latest release. However,
9+
New Relic reserves the ability to push an edge to the master. If you download a
10+
release from this repo, use the appropriate tag. New Relic usually pushes beta
11+
versions of a release to a working branch before tagging them for General
12+
Availability.
13+
14+
## Testing
15+
16+
The code includes a suite of unit tests with each package which should be used
17+
to verify your changes don't break existing functionality.
18+
19+
### Running Tests
20+
21+
Running the test suite is simple. Just invoke:
22+
23+
```bash
24+
$ make test
25+
```
26+
27+
### Writing Tests
28+
29+
For most contributions it is strongly recommended to add additional tests which
30+
exercise your changes.
31+
32+
This helps us efficiently incorporate your changes into our mainline codebase
33+
and provides a safeguard that your change won't be broken by future development.
34+
35+
There are some rare cases where code changes do not result in changed
36+
functionality (e.g. a performance optimization) and new tests are not required.
37+
In general, including tests with your pull request dramatically increases the
38+
chances it will be accepted.
39+
40+
### And Finally...
41+
42+
You are welcome to send pull requests to us - however, by doing so you agree
43+
that you are granting New Relic a non-exclusive, non-revokable, no-cost license
44+
to use the code, algorithms, patents, and ideas in that code in our products if
45+
we so choose. Fortunately, you also agree the code is provided as-is and you provide no
46+
warranties as to its fitness or correctness for any purpose.
47+
48+
If you have any feedback on how we can make contributing easier, please get in
49+
touch at [support.newrelic.com](http://support.newrelic.com) and let us know!

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ $ sudo mysql -e "GRANT REPLICATION CLIENT ON *.* TO 'newrelic'@'localhost' WITH
1717
## Installation
1818
* download an archive file for the MySQL Integration
1919
* extract `mysql-definition.yml` and `/bin` directory into `/var/db/newrelic-infra/newrelic-integrations`
20-
* add execute permissions for the binary file `nr-mysql` (if required)
20+
* add execute permissions for the binary file `nr-mysql` (if required)
2121
* extract `mysql-config.yml.sample` into `/etc/newrelic-infra/integrations.d`
2222

2323
## Usage
@@ -43,3 +43,33 @@ $ ./bin/nr-mysql -help
4343
```
4444

4545
For managing external dependencies [govendor tool](https://github.com/kardianos/govendor) is used. It is required to lock all external dependencies to specific version (if possible) into vendor directory.
46+
47+
## Contributing Code
48+
49+
We welcome code contributions (in the form of pull requests) from our user
50+
community. Before submitting a pull request please review [these guidelines](https://github.com/newrelic/nri-mysql/blob/master/CONTRIBUTING.md).
51+
52+
Following these helps us efficiently review and incorporate your contribution
53+
and avoid breaking your code with future changes to the agent.
54+
55+
## Custom Integrations
56+
57+
To extend your monitoring solution with custom metrics, we offer the Integrations
58+
Golang SDK which can be found on [github](https://github.com/newrelic/infra-integrations-sdk).
59+
60+
Refer to [our docs site](https://docs.newrelic.com/docs/infrastructure/integrations-sdk/get-started/intro-infrastructure-integrations-sdk)
61+
to get help on how to build your custom integrations.
62+
63+
## Support
64+
65+
You can find more detailed documentation [on our website](http://newrelic.com/docs),
66+
and specifically in the [Infrastructure category](https://docs.newrelic.com/docs/infrastructure).
67+
68+
If you can't find what you're looking for there, reach out to us on our [support
69+
site](http://support.newrelic.com/) or our [community forum](http://forum.newrelic.com)
70+
and we'll be happy to help you.
71+
72+
Find a bug? Contact us via [support.newrelic.com](http://support.newrelic.com/),
73+
or email support@newrelic.com.
74+
75+
New Relic, Inc.

0 commit comments

Comments
 (0)