Skip to content

Documentation Improvement: Add Example for Token Usage #1

@tashaxanavsem82

Description

@tashaxanavsem82

Enhancement Proposal

It would greatly benefit users if the documentation included more details regarding the usage of tokenA and tokenB. Specifically, providing an example of how to generate these tokens from GitHub would help users understand what is required.

Suggested Changes

  • Add a section under Installation & Usage or in a separate Authentication section.
  • Include step-by-step instructions on how to create personal access tokens in GitHub, mentioning which scopes are necessary for the bot to function effectively (e.g., repo access, issues access).

Example Addition

## Authentication

To use the Pull Merge Bot, you need to generate two GitHub personal access tokens:

1. Go to your GitHub account settings.
2. Navigate to **Developer settings** > **Personal access tokens**.
3. Click on **Generate new token**.
4. Select the necessary scopes for your usage (e.g., `repo`, `repo:status`, `public_repo`, and `Gist`).
5. Copy the tokens and set them in your environment variables as `TOKEN_A` and `TOKEN_B`.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions