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 project files and documentation #892

Merged
merged 1 commit into from
Jun 16, 2023
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
77 changes: 2 additions & 75 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,3 @@
# Contributor Covenant Code of Conduct
# Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at support@appsignal.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
Please visit [docs.appsignal.com/appsignal/code-of-conduct.html](https://docs.appsignal.com/appsignal/code-of-conduct.html) for our Code of Conduct for this project.
43 changes: 19 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,28 @@
Want to contribute to `appsignal-nodejs`? That's great! Here are a few guidelines that will help you contribute. Before we get started: Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md) to ensure that this project is a welcoming place for **everyone** to contribute to. By participating in this project you agree to abide by its terms.
# Contributing guide

### Overview
Want to contribute to this project? That's great! Here are a few guidelines
that will help you contribute.

Before we get started: Please note that this project is released with a [Code
of Conduct](CODE_OF_CONDUCT.md) to ensure that this project is a welcoming
place for **everyone** to contribute to. By participating in this project you
agree to abide by its terms.

See also the [AppSignal contributing
guidelines](https://docs.appsignal.com/appsignal/contributing.html) for all
projects.

## Overview

- [Contribution workflow](#contribution-workflow)
- [Contributing to an existing issue](#contributing-to-an-existing-issue)
- [Our labels](#our-labels)

## Contribution workflow

- Create a branch. We use `[git flow](https://github.com/nvie/gitflow)` to create branches based on `develop`.
- Create a branch based on the `main` branch.
- Make your change or bug fix.
- Send a pull request.
- The team will vote using :thumbsup: and :thumbsdown:
- Send a Pull Request.
- The team will review your change.
- Add a [changeset](https://github.com/appsignal/mono/#changeset) to your Pull
Request for the [CHANGELOG](CHANGELOG.md).
- If approved, a maintainer will merge your change.

## Contributing to an existing issue

### Finding an issue to work on

You can view the list of issues [here](https://github.com/appsignal/appsignal-nodejs/issues). The issues are labelled, so you can use the labels to get an idea of which issue could be a good fit for you. (Here's [a good article](https://medium.freecodecamp.com/finding-your-first-open-source-project-or-bug-to-work-on-1712f651e5ba) on how to find your first bug to fix).

Before getting to work, take a look at the issue and at the conversation around it. Has someone already offered to work on the issue? Has someone been assigned to the issue? If so, you might want to check with them to see whether they're still actively working on it.

If the issue is a few months old, it might be a good idea to write a short comment to double-check that the issue or feature is still a valid one to jump on.

Feel free to ask for more detail on what is expected: are there any more details or specifications you need to know?

And if at any point you get stuck: don't hesitate to ask for help.

## Our labels

@TODO: document labels.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# AppSignal for Node.js

The AppSignal for Node.js library.

- [AppSignal.com website][appsignal]
- [Documentation][docs]
- [Support][contact]

![npm (scoped)](https://img.shields.io/npm/v/@appsignal/nodejs) [![Build Status](https://appsignal.semaphoreci.com/badges/appsignal-nodejs/branches/main.svg?style=shields&key=7dd9fe64-f1d5-437b-a5b7-8ac337a26c5b)](https://appsignal.semaphoreci.com/projects/appsignal-nodejs) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

The core AppSignal for Node.js library.

## Installation

Please follow our [installation guide](https://docs.appsignal.com/nodejs/3.x/installation) in our documentation. We try to automatically instrument as many packages as possible, but may not always be able to. Make to sure follow any [instructions to add manual instrumentation](https://docs.appsignal.com/nodejs/3.x/integrations).
Expand Down
16 changes: 16 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Support

[Contact us][contact] and speak directly with the engineers working on
AppSignal. They will help you get set up, tweak your code and make sure you get
the most out of using AppSignal. You can also find our documentation at
[docs.appsignal.com](https://docs.appsignal.com/).

We do not recommend creating an issue on the Python package's GitHub project if
it concerns your private app data. During the support process we'll need the
AppSignal logs and other resources that contain your app's private data,
something for which the public GitHub issue tracker is not suited.

Please contact us on our website [appsignal.com](https://appsignal.com/) or via
email at [support@appsignal.com][contact].

[contact]: mailto:support@appsignal.com