Fix links in contributing.md to use HTTPS
Updated links in contributing guidelines to use HTTPS.
Summary of Changes
Hello @partev, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on a minor but important maintenance task: updating all external links within the docs/contributing.md file to use the secure HTTPS protocol. This change enhances the overall security posture of the documentation and ensures that users are directed to encrypted connections when accessing external resources, aligning with modern web best practices.
Highlights
-
Protocol Update: All
http://links withindocs/contributing.mdhave been updated to usehttps://for improved security and consistency across the documentation. -
Documentation and Repository Links: Links pointing to JAX's official documentation (
docs.jax.dev) and the JAX GitHub repository (github.com/jax-ml/jax) have been standardized to use the secure HTTPS protocol. -
URL Standardization: The
git remote add upstreamcommand in the contributing guidelines now useshttps://github.com/jax-ml/jax, removing thewwwsubdomain for consistency.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.
@jakevdp I think this is ready to be merged
@jakevdp in the sentence:
- Contributing in any of the above ways to the broader ecosystem of libraries built on JAX
the link to "libraries built on JAX" is also broken. The closest thing to it is https://docs.jax.dev/en/latest/#ecosystem, should include that fix as well in this PR?