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.

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

Update CONTRIBUTING.md and SUPPORT.md #5

Merged
merged 1 commit into from
Dec 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 18 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,26 @@
# Copyright (c) 2021, 2022 by Delphix. All rights reserved.
#

## Contributing
1. Fork the project.
2. Refer to [README.md](README.md) for the setup, pre-configurations and running the project.
3. One you have run the script successfully using `make run` (Linux/MacOS) or `python src\main.py` (Windows)
7. Make your bug fix or new feature.
8. Add tests for your code.
9. Send a pull request.
Not accepting any external contributions as of now.

Contributions must be signed as `User Name <user@email.com>`. Make sure to [set up Git with user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup). Bug fixes should branch from the current stable branch. New features should be based on the release branch.
<div style="display:none">
--- Hidden Block ----

## Contributing
1. Fork the project.
2. Refer to [README.md](README.md) for the setup, pre-configurations and running the project.
3. Once you have run the script successfully using `make run` (Linux/MacOS) or `python src\main.py` (Windows)
7. Make your bug fix or new feature.
8. Add tests for your code.
9. Send a pull request.

Contributions must be signed as `User Name <user@email.com>`. Make sure to [set up Git with user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup). Bug fixes should branch from the current stable branch. New features should be based on the release branch.

## Contributor Agreement
All contributors are required to sign the Delphix Contributor agreement prior to contributing code to an open source repository. This process is handled automatically by [cla-assistant](https://cla-assistant.io/). Simply open a pull request and a bot will automatically check to see if you have signed the latest agreement. If not, you will be prompted to do so as part of the pull request process.

## Contributor Agreement
All contributors are required to sign the Delphix Contributor agreement prior to contributing code to an open source repository. This process is handled automatically by [cla-assistant](https://cla-assistant.io/). Simply open a pull request and a bot will automatically check to see if you have signed the latest agreement. If not, you will be prompted to do so as part of the pull request process.
------------------------
</div>

## Code of Conduct
This project operates under the Delphix Code of Conduct. By participating in this project you agree to abide by its terms.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ These instructions will provide the information you need to extract data from DC
* This [GitHub repository](https://github.com/delphix/dct-newrelic-integration)

<hr>
<h4> Supported Python Versions </h4>
<h4> Supported Python Versions and OS </h4>
<hr>

- MacOS - Python3.7 and Python3.8
Expand Down Expand Up @@ -63,7 +63,7 @@ Note: You may modify the Python script directly, but it is best practice to spec
<hr>

In production, it is common to use a scheduler, such as a systemd, nohup, or wininit.exe, to ensure the script continually runs. For example, the following nohup command will run the script every N seconds based on the Interval provided in the `dct_nr_config.ini` file:
```nohup python src/main.py &```
```nohup make run &```


On each execution, this script will extract the following metrics from all registered Delphix engines:
Expand Down
10 changes: 10 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
## Support
This software is provided as-is, without warranty of any kind or commercial support through Delphix. See the associated license for additional details. Questions, issues, feature requests, and contributions should be directed to the community as outlined in the [Delphix Community Guidelines](https://delphix.github.io/community-guidelines.html).

<hr>
<h4> Supported Python Versions and OS </h4>
<hr>

- MacOS - Python3.7 and Python3.8
- Linux - Python3.7+
- Windows - Python3.7+

<hr>