Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

65 lines (40 loc) · 3.22 KB
Raw

Contributing to this repository

Thank you for your interest in contributing to our repository and suggesting new domains to add to the list of compatible domains with passkeys! This guide will walk you through the process of contributing and submitting new issues.

Repository Contribution

To contribute to our repository and make changes to the list of compatible domains with passkeys, follow these steps:

  1. Fork the Repository: Navigate to the main page of the repository on GitHub and click on the "Fork" button to create a copy of the repository under your GitHub account.

  2. Clone the Repository: Once you have forked the repository, navigate to your GitHub account, find the forked repository, and copy the repository URL. Open your preferred terminal or Git client and execute the following command:

    git clone <repository-url>

    Replace <repository-url> with the URL you copied.

  3. Create a New Branch: Change into the cloned repository directory using the following command:

    cd <repository-name>

    Replace <repository-name> with the name of the repository you cloned. Then, create a new branch to work on your changes:

    git checkout -b <branch-name>

    Replace <branch-name> with a descriptive name for your branch.

  4. Make Changes: Open the repository files in your preferred text editor or IDE. Locate the file related to the list of compatible domains with passkeys and make the necessary additions or modifications to the list, ensuring the format is maintained.

  5. Commit and Push Changes: Once you have made the desired changes, save the file. In your terminal or Git client, execute the following commands to stage and commit the changes:

    git add .
git commit -m "[NEW] domain-name.com"

    Finally, push the changes to your forked repository:

    git push origin <branch-name>

    Replace <branch-name> with the name of the branch you created.

  6. Create a Pull Request: After pushing the changes, navigate to your forked repository on GitHub. Click on the "Compare & pull request" button to start the pull request. Provide a descriptive title and additional comments explaining the changes you made. Finally, click on the "Create pull request" button to submit your changes for review.

Providing Detailed Information

When submitting a new pull request, it is important to include as much detail as possible. Here are some suggestions for the information you can provide:

  • Domain Name: The name of the domain you are suggesting.
  • Purpose: A brief description of the domain's purpose or the service it offers.
  • Relevance: Link proof with images or videos of the working flow that shows the domain supporting passkeys.
  • Additional Information: Any additional details, links, or resources that may support your suggestion.

By following this guide, you can contribute to our repository by making changes to the list of compatible domains with passkeys and suggest new domains to add by submitting new pull requests. Your contributions and suggestions are highly appreciated and help improve the overall

Side note

You can of course contribute to improving the CI and the website attached to this repository.