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

issue to better code #72

Open
nftehsansarmaye opened this issue Jun 3, 2024 · 0 comments
Open

issue to better code #72

nftehsansarmaye opened this issue Jun 3, 2024 · 0 comments

Comments

@nftehsansarmaye
Copy link

This YAML code is for configuring the support page on GitHub. Overall, the code looks correct, but there are a few points to consider:

  1. Format of the "about" text:

    • It is better to use a block scalar (|) in the "about" section instead of a folded scalar (>), as it improves the readability of the text.
  2. Usage of URL:

    • The URL is repeated twice in the "about" section, which can be unnecessary. It is better to remove one of them.
  3. Link name:

    • The link name "Need Support? Visit the Fuel Forum" might be a bit long. You can make it shorter and clearer.

With these modifications, the code would look like this:

blank_issues_enabled: true
contact_links:
  - name: Fuel Forum Support
    url: https://forum.fuel.network
    about: |
      For support queries, please visit the Fuel Forum at https://forum.fuel.network.
      Only bug reports and feature requests in this repo are guaranteed a response.

These changes improve the readability and simplicity of the link.

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

No branches or pull requests

1 participant