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

Nr-309883 migrate from opensource newrelic #18902

Merged
merged 5 commits into from
Oct 11, 2024
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "New Relic open source community code of conduct - reporting guide"
metaDescription: "Learn how to report violations of the New Relic code of conduct for open source community."
redirects:
- https://opensource.newrelic.com/code-of-conduct-reporting
freshnessValidatedDate: never
---

If you believe someone is violating the [Code of Conduct](/docs/licenses/open-source/code-of-conduct), we ask that you report it to the New Relic open source steering committee by emailing [email protected]. All reports will be kept confidential to the extent possible.

If you are unsure whether the incident is a violation, or whether the space where it happened is covered by this [Code of Conduct](/docs/licenses/open-source/code-of-conduct), we encourage you to still report it. We would much rather have a few extra reports where we decide to take no action, rather than miss a report of an actual violation. We do not look negatively on you if we find the incident is not a violation. And knowing about incidents that are not violations, or that happen outside our spaces, can also help us to improve the [Code of Conduct](/docs/licenses/open-source/code-of-conduct) or the processes surrounding it.

In your report please include information that will help us start an investigation, such as:

- Your contact info (so we can get in touch with you if we need to follow up).
- Names (real, nicknames, or pseudonyms) of any individuals involved. If there were other witnesses besides you, please try to include them as well.
- When and where the incident occurred. Please be as specific as possible.
- Your account of what occurred. If there is a publicly available record (for example, a mailing list archive or Slack history) please include a link.
- Any extra context you believe existed for the incident.
- If you believe this incident is ongoing.
- Any other information you believe we should have.

## What happens after you file a report?
All reports will be reviewed by New Relic’s open source steering committee.

We will investigate every complaint, but you may not receive a direct response. We will use our discretion in determining when and how to follow up on reported incidents, which may range from not taking action to direct actions such as permanent ban from the project or community. Before any action is taken, we will notify the accused of the report and provide them an opportunity to discuss it. The identity of the reporter will be omitted from the details of the report supplied to the accused.

In potentially harmful situations, such as ongoing harassment or threats to anyone’s safety, we may take action without notice.

We encourage New Relic employees to report any misconduct they may experience to Human Resources or to any senior manager through the reporting process outlined in our anti-harassment policy and training.

<Callout variant="important">
Modified from original. Original text courtesy of [Django Project's Reporting Guide](https://www.djangoproject.com/conduct/reporting/) and [Google Community Gidelines](https://opensource.google/conduct/).
</Callout>

41 changes: 41 additions & 0 deletions src/content/docs/licenses/open-source/code-of-conduct.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "New Relic open source community code of conduct"
metaDescription: "Participate in New Relic's open source community with kindness and respect: our Code of Conduct sets the standard."
redirects:
- https://opensource.newrelic.com/code-of-conduct
freshnessValidatedDate: never
---

We believe in the power of open source to bring together developers and ideas to solve tricky problems and create the innovative software the world needs.

We respect all people in our community, regardless of their background or the extent of their contributions, and encourage participation from diverse sources. This Code of Conduct documents the principles we encourage in, and expect of, the open source community.

- Be friendly and patient.
- Be welcoming. We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to, members of any race, ethnicity, culture, national origin, colour, immigration status, social or economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
- Be considerate. Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we’re a world-wide community, so you might not be communicating in someone else’s primary language.
- Be respectful. Not all of us will agree all the time, but disagreement is no excuse for poor behavior or poor manners. We all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the New Relic community should be respectful to everyone.
- Be careful in the words that you choose. We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behaviors aren't acceptable. This includes, but is not limited to:
- Violent threats or language directed against another person
- Discriminatory jokes and language
- Posting sexualized language or imagery
- Posting (or threatening to post) other people's personally identifying information (“doxing”)
- Personal insults, especially those using racist or sexist terms
- Unwelcome sexual attention
- Advocating for, or encouraging, any of the above behavior
- Repeated harassment of others. In general, if someone asks you to stop, then stop.
- When we disagree, try to understand why. Disagreements, both social and technical, happen all the time and New Relic is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we’re all different. The strength of New Relic comes from its varied community of people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.

This isn’t an exhaustive list of things that you can’t do. Rather, take it in the spirit in which it’s intended - guidelines to make it easier to enrich all of us and the technical communities in which we participate.

The spirit of this Code of Conduct applies equally to everyone in all the spaces where the New Relic open source community interacts in the pursuit of creating software. This includes New Relic-managed Slack, mailing lists, Github Issues, and any other forums which the New Relic open source community uses for communication.

Our open source communities agree to abide by New Relic’s [Acceptable Use Policy](/docs/licenses/license-information/general-usage-licenses/acceptable-use-policy?_gl=1*1fkmats*_gcl_aw*R0NMLjE3MjE3NDA0NzIuQ2p3S0NBandxZjIwQmhCd0Vpd0F0N2R0ZGQxa01LaHBmazl1OFNQZTlTRU02eHZ1UThaZXk3dVdoQ3F2Y09iX2JzOFJpbENRUDlwZVpob0NGdkFRQXZEX0J3RQ..*_gcl_au*MTUzNzk1ODMxOS4xNzIwNDI5NDM0*_ga*NzE1OTA0NDA1LjE3MjA0Mjk0MzU.*_ga_R5EF3MCG7B*MTcyNzY4MjU5NS4yMjcuMS4xNzI3NjgyNzkyLjYwLjEuMjExNjcyNzg4OA..).

If you believe someone is violating the code of conduct, we ask that you report it by [emailing us]([email protected]). For more details please see our [Reporting Guidelines](/docs/licenses/open-source/code-of-conduct-reporting).

Modified from original. Original text courtesy of Django Project's Code of Conduct.

<Callout variant="important">
Modified from original. Original text courtesy of [Django Project's Reporting Guide](https://www.djangoproject.com/conduct).
</Callout>

51 changes: 51 additions & 0 deletions src/content/docs/licenses/open-source/contribute.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: "Contributing to a New Relic open source project"
metaDescription: "Learn how to contrinute to a New Relic open source project: code reviews, issue tracking, and community etiquette for seamless collaboration."
redirects:
- https://opensource.newrelic.com/contributing
freshnessValidatedDate: never
---
Watch [this video](https://www.youtube.com/watch?v=3zalIudBF6A) to understand a standard fork-and-pull-request code contribution workflow.

For those newer to open source contribution at New Relic, the following points encapsulate the major steps and issues. For command line description of this workflow, [consult this documentation](https://gist.github.com/tangollama/5d9d63fef0ed4498fb5fbb057bb5983d).

Your app is now sending browser data to New Relic. View this data in New Relic, under <DNT>**Browser**</DNT>.

<Steps>
<Step>
## Fork a Repository
Instead of requiring write access to the repository, a fork allows you the ability to modify code and contribute changes via a pull request.<p/>
<img
title="sample new relic repo"
alt="sample new relic repo stats"
src="/images/nr1-browser-analyzer-repo.webp"
/>
Navigate to the repository in GitHub and click the **Fork** button.<p/>
</Step>

<Step>
## Implement changes on your Fork
Now that you have a copy of the repository, implement changes against your forked copy of the code but executing the clone command, and modify your copy of the code.

### Commit message guidance
As you commit changes to your fork, you want to ensure that your commit messages are human-readable, relevant, descriptive, and follow a standard methodology so that tooling can automate the creation of changelogs.

To support that objective, New Relic open source projects seek to follow the Conventional Commit specification for git commit messages.

**Ensure that your:**
- Commit messages follow the [Convention Commit specification](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#specification)
- Commits tie back to a specific [Issue](https://help.github.com/en/github/managing-your-work-on-github/about-issues) in the upstream repository (**Hint:** If there isn't an issue for your change, add it yourself :))

</Step>

<Step>
## Initiate a Pull Request
Once you've committed your changes to your fork, you can now issue a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) back to the New Relic project.
</Step>

<Step>
## Accept the New Relic CLA (Contributor License Agreement)
Finally, if you've not contributed to a New Relic open source project before, we're going to prompt you to electronically sign our [Contributor License Agreement (CLA)](https://opensource.newrelic.com/cla), highlighting that you're freely providing code for the benefit of the open source project and community.
</Step>
</Steps>

121 changes: 121 additions & 0 deletions src/content/docs/licenses/open-source/oss-category.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
title: "New Relic open source categories"
metaDescription: "Every public repository in the New Relic and New Relic Experimental GitHub organizations leverages one of the open source categories."
redirects:
- https://opensource.newrelic.com/oss-category
freshnessValidatedDate: never
---

Every public repository in the New Relic and New Relic Experimental GitHub organizations leverages one of the following open source categories:

<CollapserGroup>
<Collapser
id="community-project"
title="Community Project"
>
This code is developed in the open with input from the community through issues and PRs. There is an active maintainer team within New Relic, troubleshooting support in the New Relic Explorers Hub, and the documentation is available in the project repository.
<Callout variant="important">
This is an official New Relic open source community project, supported by maintainers within New Relic.
</Callout>

**Requirements**
- Complies with New Relic's legal and security requirements for open source software
- Contains the appropriate New Relic open source category header in the repository's README file
- Has active maintainer / maintainers, including at least one Relic
- Troubleshooting support via the New Relic Explorers Hub
- Issues and PR’s managed in GitHub
- Documentation reviewed by the New Relic documentation team
- Linted code
- An automated release pipeline
</Collapser>

<Collapser
id="community-plus"
title="Community Plus"
>
This code is developed in the open with input from the community through issues and PRs. A New Relic engineering team serves as the maintainer. Troubleshooting support is available in the New Relic Explorers Hub, and documentation is available in the project repository and [New Relic Docs](https://docs.newrelic.com).

<Callout variant="important">
This code is currently maintained by New Relic engineering teams and delivered here in GitHub. See the README for troubleshooting and defect reporting instructions.
</Callout>

**Requirements**
- Complies with New Relic's legal and security requirements for open source software
- Contains the appropriate New Relic open source category header in the repository's README file
- Is maintained by a New Relic engineering team
- Troubleshooting support via the New Relic Explorers Hub
- Issues and PR’s managed in GitHub
- For additional details on support options, see the [open source support policy](/docs/licenses/license-information/general-usage-licenses/global-technical-support-offerings?_gl=1*1ftd2ji*_gcl_aw*R0NMLjE3MjE3NDA0NzIuQ2p3S0NBandxZjIwQmhCd0Vpd0F0N2R0ZGQxa01LaHBmazl1OFNQZTlTRU02eHZ1UThaZXk3dVdoQ3F2Y09iX2JzOFJpbENRUDlwZVpob0NGdkFRQXZEX0J3RQ..*_gcl_au*MTUzNzk1ODMxOS4xNzIwNDI5NDM0*_ga*NzE1OTA0NDA1LjE3MjA0Mjk0MzU.*_ga_R5EF3MCG7B*MTcyNzQxNzgxOS4yMjIuMS4xNzI3NDE4OTQxLjYwLjEuMjI2NDAzOTc2)
- Documentation reviewed by the New Relic documentation team
- Linted code
- An automated release pipeline
</Collapser>

<Collapser
id="one-catalog"
title="New Relic Catalog"
>
This code is a part of the New Relic catalog. It meets the criteria for a Community Project; but it also contains UI workflows for configuration. Most Catalog projects seek to maintain a public roadmap, often expressed in a GitHub Project board and Issues within the repository.
<Callout variant="important">
This code is a part of the New Relic catalog. It's available for installation and configuration via the New Relic homepage. You can install it within New Relic.
</Callout>

**Requirements**
- All the requirements of a Community Project
- An empty state application workflow that guides users through the setup of configuration data that is stored in NerdStorage
- Architectural review (including UX) by New Relic
- (Optional) maintains a public roadmap (recommended via a GitHub project in the repo)
</Collapser>

<Collapser
id="example-code"
title="Example Code"
>
This code demonstrates an aspect of building on the New Relic platform. Find the complete description of its usage and other relevant docs in the README. There is no long-term maintainer for this code nor is support provided, but the author(s) may address future updates / needs as platform features change.

<Callout variant="important">
Not meant for production deployment, but is provided as a working example of a concept. Comes with no ongoing support or maintenance, but you're welcome to submit issues and PR's to the repo.
</Callout>

**Requirements**
- Complies with New Relic's legal and security requirements for open source software
- Contains the appropriate New Relic open source category header in the repository's README file
- (Optional) Issues are available at the project author's discretion
- Documentation reviewed by the New Relic documentation team
- Linted code
</Collapser>

<Collapser
id="experimental"
title="New Relic Experimental"
>
This code solves an interesting problem but does not yet have an active maintainer(s). The project is being developed in the open for the purpose of feedback on a new feature or function.

<Callout variant="important">
This code is not necessarily used in production but is being developed in the open. It is provided with no expectation of support, ongoing development, or maintenance.
</Callout>

**Requirements**
- Complies with New Relic's legal and security requirements for open source software
- Contains the appropriate New Relic open source category header in the repository's README file
- Typically hosted in the New Relic Experimental GitHub org
- (Optional) Issues at the project owner's discretion
</Collapser>

<Collapser
id="archived"
title="Archived"
>
This code is read-only. There is neither a maintainer team nor support.
<Callout variant="important">
This code has been moved into a read-only state. It is no longer supported and is available for cloning only.
</Callout>

**Requirements**
- Complies with New Relic's legal requirements for open source software
- Contains the appropriate New Relic open source category header in the repository's README file
- Previous references to Support should be modified or removed from the README
- Project is read-only and available for cloning only

</Collapser>
</CollapserGroup>
12 changes: 11 additions & 1 deletion src/nav/licenses.yml
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,17 @@ pages:
pages:
- title: End-of-life policy
path: /docs/licenses/end-of-life/notification-changes-new-relic-saas-features-distributed-software
- title: Open source
pages:
- title: OSS categories
path: /docs/licenses/open-source/oss-category
- title: Contribute
path: /docs/licenses/open-source/contribute
- title: Code of Conduct
path: /docs/licenses/open-source/code-of-conduct
- title: Code of Conduct violations
path: /docs/licenses/open-source/code-of-conduct-reporting
- title: Translated documentation
pages:
- title: Translation disclaimer
path: /docs/licenses/translated-documentation/translation-disclaimer
path: /docs/licenses/translated-documentation/translation-disclaimer
Binary file added static/images/nr1-browser-analyzer-repo.webp
Binary file not shown.
Loading