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

refactor: Prepare OSS #98

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

HassanBahati
Copy link
Collaborator

@HassanBahati HassanBahati commented Aug 6, 2024

This PR adds;

  • Contributor Guide
  • Issue templates
  • Pull request templates
  • PR title validation workflow

Copy link

docs-page bot commented Aug 6, 2024

To view this pull requests documentation preview, visit the following URL:

react-query-firebase.invertase.dev/~98

Documentation is deployed and generated using docs.page.

@CLAassistant
Copy link

CLAassistant commented Aug 6, 2024

CLA assistant check
All committers have signed the CLA.

@HassanBahati HassanBahati changed the title ci: Add pr title validation workflow refactor: Prepare OSS Aug 6, 2024
@HassanBahati HassanBahati marked this pull request as ready for review August 6, 2024 14:16
@HassanBahati HassanBahati marked this pull request as draft November 4, 2024 15:30
value: |
---

- type: dropdown
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't need this one

@@ -0,0 +1,10 @@
---
name: "\U0001F4DA Documentation Feedback"
about: Report an issue with the https://react-query-firebase.invertase.dev/ documentation or suggest an improvement.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong url

- [ ] No, this is *not* a breaking change.

<!-- Links -->
[issue database]: https://github.com/invertase/react-query-firebase/issues
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong urls


### New Features

- If you'd like to add a feature to the library that doesn't already exist, feel free to describe the feature in a new [GitHub issue](https://github.com/invertase/react-query-firebase/issues/new?assignees=&labels=feature+request%2Ctriage&template=feature-request.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url


### Bug Report

- If you find a bug, please first report it using [GitHub issues](https://github.com/invertase/react-query-firebase/issues/new?assignees=&labels=bug%2Ctriage&template=bug_report.yml).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url

### 2. Forking & cloning the repository

- Ensure all the dependencies described in the previous section are installed.
- Fork `https://github.com/invertase/react-query-firebase` into your own GitHub account. If
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url

you already have a fork, and are now installing a development environment on
a new machine, make sure you've updated your fork so that you don't use stale
configuration options from long ago.
- `git clone git@github.com:<your_name_here>/react-query-firebase.git`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url

a new machine, make sure you've updated your fork so that you don't use stale
configuration options from long ago.
- `git clone git@github.com:<your_name_here>/react-query-firebase.git`
- `git remote add upstream git@github.com:invertase/react-query-firebase.git` (So that you
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants