react-navigation / bot

A GitHub bot for react-navigation issues (currently unused)

React Navigation 7

Routing and navigation for your React Native apps.

Documentation can be found at reactnavigation.org.

This branch contains the code for the pre-release version of React Navigation 7. You can find the code for the latest stable version in the 6.x branch.

Package Versions

Name	Latest Version
@react-navigation/bottom-tabs
@react-navigation/core
@react-navigation/devtools
@react-navigation/drawer
@react-navigation/elements
@react-navigation/material-top-tabs
@react-navigation/native-stack
@react-navigation/native
@react-navigation/routers
@react-navigation/stack
react-native-tab-view

Contributing

Please read through our contribution guide to get started!

Installing from a fork on GitHub

Since we use a monorepo, it's not possible to install a package from the repository URL. If you need to install a forked version from Git, you can use gitpkg.

First install gitpkg:

yarn global add gitpkg

Then follow these steps to publish and install a forked package:

1. Fork this repo to your account and clone the forked repo to your local machine
2. Open a Terminal and cd to the location of the cloned repo
3. Run yarn to install any dependencies
4. If you want to make any changes, make them and commit
5. Run yarn lerna run prepack to perform the build steps
6. Now cd to the package directory that you want to use (e.g. cd packages/stack for @react-navigation/stack)
7. Run gitpkg publish to publish the package to your repo

After publishing, you should see something like this:

Package uploaded to [email protected]:<user>/<repo>.git with the name <name>

You can now install the dependency in your project:

yarn add <user>/<repo>.git#<name>

Remember to replace <user>, <repo> and <name> with right values.

bot's Issues

test

EDIT: oops

[RFC] [WIP] Wishlist of behaviours for the bot

I'm using this issue to list all the different behaviours I wish this bot would have.

Overall idea

Basically, the purpose of this bot would be to help out in keeping the issues & PRs sections of react-navigation "clean".

My definition of clean basically means that every open issue is:

• a bug that needs a code fix
• a modification the documentation needs
• a feature that multiple people (+1 at least one "good rep dev") think it's useful

List of behaviours

• Reply to (new) question tagged issues

When a new issue gets tagged with as question, the bot should close it and reply with:

Hi @(user)! It looks like this is not a bug of the library nor a feature request, so I'll close it: I suggest next time you use [Stack Overflow](https://stackoverflow.com/search?q=react-navigation) which is better suited for answering these types of questions. I also encourage you to join the [Reactiflux](https://www.reactiflux.com/) community on Discord. There are React Native and React Navigation channels with helpful people who might be able to answer your question. I would also like to mention that there is a collection of helpful links and tutorials for React Navigation in the [README](https://github.com/react-community/react-navigation#community-contributions) which might be helpful for you.

If you believe that you are experiencing a bug or have a feature request, please open a new Issue following the dedicated template or submit a PR.

Currently after the first paragraph I add a second with some extra info to point the user in the right direction (ex. if the question is about the Drawer I link them to the README section with the Drawer article series by Gant ) but the bot surely won't be able to. #goodenough

• Autoclose issues that don't follow any template

When a user create an issue that doesn't follow the template, it should close it right away saying something along these lines:

Closing because you haven't followed the issue template; please open a new one that follows the template.
Without that, it's nearly impossible to understand & investigate the issue. I suggest you also try (in the new issue) to answer/explain in a way that fits these questions:

1. have you tried updating to the latest release?
1. does it happen only on Android/iOS?
1. does it happen on both Debug and Release modes?
1. does it happen with Debugger On or Off? Both?
1. Can you provide a GIF or a repo or a snack to reproduce this issue?

Maybe we should add an invalid tag that triggers this behaviour too?

Other notes

• I want to play with the issue templates, since I joined the OSM I've already learned that we could create multiple templates. I'll write some more later on.

---

This is not the full list of behaviours yet, but I decided to start writing it anyway to not forget/delay this further.