Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
jefshe committed Jan 4, 2024
2 parents e39255f + 57d2241 commit be29deb
Show file tree
Hide file tree
Showing 44 changed files with 31,834 additions and 12,140 deletions.
4 changes: 2 additions & 2 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"root": true,
"ignorePatterns": ["dist", "node_modules"],
"extends": ["@upstatement", "plugin:jest/recommended"],
"ignorePatterns": ["mocks", "index.*", "dist", "node_modules"],
"extends": ["plugin:jest/recommended"],
"plugins": ["jest"],
"parserOptions": {
"sourceType": "module"
Expand Down
24 changes: 8 additions & 16 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ We look forward to your contributions!

If you have a question about this project, how to use it, or just need clarification about something:

- Open an Issue at https://github.com/Upstatement/firestore-jest-mock/issues
- Open an Issue at https://github.com/sbatson5/firestore-jest-mock/issues
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.

Expand All @@ -46,7 +46,7 @@ Once it's filed:

If you run into an error or bug with the project:

- Open an Issue at https://github.com/Upstatement/firestore-jest-mock/issues
- Open an Issue at https://github.com/sbatson5/firestore-jest-mock/issues
- Include _reproduction steps_ that someone else can follow to recreate the bug or error on their own.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.

Expand All @@ -62,7 +62,7 @@ Once it's filed:

If the project doesn't do something you need or want it to do:

- Open an Issue at https://github.com/Upstatement/firestore-jest-mock/issues
- Open an Issue at https://github.com/sbatson5/firestore-jest-mock/issues
- Provide as much context as you can about what you're running into.
- Please try and be clear about why existing features and alternatives would not work for you.

Expand Down Expand Up @@ -104,7 +104,7 @@ To contribute documentation:
- Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything.
- In your commit message(s), begin the first line with `docs:`. For example: `docs: Adding a doc contrib section to CONTRIBUTING.md`.
- Write clear, concise commit message(s) using [conventional-changelog format](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md). Documentation commits should use `docs(<component>): <message>`.
- Go to https://github.com/Upstatement/firestore-jest-mock/pulls and open a new pull request with your changes.
- Go to https://github.com/sbatson5/firestore-jest-mock/pulls and open a new pull request with your changes.
- If your PR is connected to an open issue, add a line in your PR's description that says `Fixes: #123`, where `#123` is the number of the issue you're fixing.

Once you've filed the PR:
Expand All @@ -129,7 +129,7 @@ To contribute code:
- Include any [additional documentation](#contribute-documentation) the changes might need.
- Write clear, concise commit message(s) using [conventional-changelog format](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md).
- Dependency updates, additions, or removals must be in individual commits, and the message must use the format: `<prefix>(deps): PKG@VERSION`, where `<prefix>` is any of the usual `conventional-changelog` prefixes, at your discretion.
- Go to https://github.com/Upstatement/firestore-jest-mock/pulls and open a new pull request with your changes.
- Go to https://github.com/sbatson5/firestore-jest-mock/pulls and open a new pull request with your changes.
- If your PR is connected to an open issue, add a line in your PR's description that says `Fixes: #123`, where `#123` is the number of the issue you're fixing.

Once you've filed the PR:
Expand All @@ -147,7 +147,7 @@ Sometimes, the `support` label will be added to things that turn out to actually

In order to help other folks out with their questions:

- Go to the issue tracker and [filter open issues by the `support` label](https://github.com/Upstatement/firestore-jest-mock/issues?q=is%3Aopen+is%3Aissue+label%3Asupport).
- Go to the issue tracker and [filter open issues by the `support` label](https://github.com/sbatson5/firestore-jest-mock/issues?q=is%3Aopen+is%3Aissue+label%3Asupport).
- Read through the list until you find something that you're familiar enough with to give an answer to.
- Respond to the issue with whatever details are needed to clarify the question, or get more details about what's going on.
- Once the discussion wraps up and things are clarified, either close the issue, or ask the original issue filer (or a maintainer) to close it for you.
Expand All @@ -162,7 +162,7 @@ Some notes on picking up support issues:

One of the most important tasks in handling issues is labeling them usefully and accurately. All other tasks involving issues ultimately rely on the issue being classified in such a way that relevant parties looking to do their own tasks can find them quickly and easily.

In order to label issues, [open up the list of unlabeled issues](https://github.com/Upstatement/firestore-jest-mock/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, **from newest to oldest**, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, skip the issue and try the next one: don't feel obligated to label each and every issue yourself!
In order to label issues, [open up the list of unlabeled issues](https://github.com/sbatson5/firestore-jest-mock/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, **from newest to oldest**, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, skip the issue and try the next one: don't feel obligated to label each and every issue yourself!

| Label | Apply When | Notes |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -197,7 +197,7 @@ To clean up issues and PRs:
- not marked as `starter` or `help wanted` (these might stick around for a while, in general, as they're intended to be available)
- no explicit messages in the comments asking for it to be left open
- does not belong to a milestone
- Leave a message when closing saying "Cleaning up stale issue. Please reopen or ping us if and when you're ready to resume this. See the [contributing guidelines](https://github.com/Upstatement/firestore-jest-mock/blob/master/CONTRIBUTING.md#clean-up-issues-and-prs) for more details."
- Leave a message when closing saying "Cleaning up stale issue. Please reopen or ping us if and when you're ready to resume this. See the [contributing guidelines](https://github.com/sbatson5/firestore-jest-mock/blob/master/CONTRIBUTING.md#clean-up-issues-and-prs) for more details."

## Review Pull Requests

Expand All @@ -211,14 +211,6 @@ Some notes:
- Please make sure you're familiar with the code or documentation being updated, unless it's a minor change (spellchecking, minor formatting, etc). You may @mention another project member who you think is better suited for the review, but still provide a non-approving review of your own.
- Be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) -- always respond with respect, be understanding, but don't feel like you need to sacrifice your standards for their sake, either. Just don't be a jerk about it?

## Merge Pull Requests

TBD - need to hash out a bit more of this process.

## Tag A Release

TBD - need to hash out a bit more of this process. The most important bit here is probably that all tests must pass, and tags must use [semver](https://semver.org).

## Attribution

This guide was generated using the WeAllJS `CONTRIBUTING.md` generator. [Make your own](https://npm.im/weallcontribute)!
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ yarn-error.log*
# Jest
/coverage
server/coverage

# Build artifacts
/mocks
/index.*
4 changes: 0 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,6 @@ Enforcement of those guidelines after violations overlapping with the above are

Once the maintainers get involved, they will follow a documented series of steps and do their best to preserve the well-being of project members. This section covers actual concrete steps.

### Contacting Maintainers

To contact members of the Upstatement engineering team, send an email to tech@upstatement.com

### Further Enforcement

If you've already followed the [initial enforcement steps](#enforcement), these are the steps maintainers will take for further enforcement, as needed:
Expand Down
Loading

0 comments on commit be29deb

Please sign in to comment.