CA Resources

Follow this step-by-step guide to contribute to CA Resources and help us enhance our community-driven project!

This guide assumes you have a GitHub account and are familiar with the basics of Git and GitHub.

Fork the Repository

Begin by visiting the project repository and clicking the Fork button. This action creates a personal copy of the repository under your account, allowing you to make changes without affecting the original project. For more details, refer to the GitHub Docs on Forking.

Clone Your Fork

Next, clone your forked repository to your local machine. This allows you to work on your contributions in your local development environment.

git clone https://github.com/your-username/ca-resources.git

Make sure to replace your-username with your actual GitHub username.

Create a New Branch

Before making any changes, create a new branch with a descriptive name that reflects the nature of your contribution. This helps keep your work organized and makes it easier for others to review.

git checkout -b add-resource

Steps to Gather Resource Information

Gather Title

Using developer tools, inspect the website’s <title> element inside the <head> tag and copy the text to use as the resource title.

gather title

Get the URL

Copy the main website URL. If the webpage is a subpage, it's acceptable to use it as long as it directs users to the main webpage where the resource is located.

Get the Description

Look for the <meta name="description" content="..."> tag in the <head> section. Copy the content attribute's value as the description.

gather description

If it's not available, you can use AI to describe the website.

Find the Icon

Use favicon.ico if there are no icons available, but try to find a high-resolution icons first. If multiple icons are available, choose one that is similar to the favicon used.

Some websites may not have an icon; if that’s the case, don’t use the icon attribute. Store icons in the relevant folder inside /public/resources/.

Example Submission

<Cards>
  <CustomCard
    title="Altassian"
    icon="/resources/colors/atlassian.svg"
    description="Start designing and developing beautiful product experiences with Atlassian Design System UI foundations, components, and standards."
    href="https://atlassian.design/foundations/color-new"
  />
  {/* ... */}
</Cards>

Without icon

<Cards>
  <CustomCard
    title="Altassian"
    description="Start designing and developing beautiful product experiences with Atlassian Design System UI foundations, components, and standards."
    href="https://atlassian.design/foundations/color-new"
  />
  {/* ... */}
</Cards>

If you prefer, you can also create an issue to suggest improvements or report problems.

Adding a New Resource Page

If you want to add a new resource page, follow these steps:

Create a New Content File

Create a new file in the contents folder to ensure the added resource is displayed on the page. Name the file appropriately to reflect the resource category or specific resource you are adding.

file-converters.mdx

---
title: File Converters
description: Discover online tools to convert files easily and efficiently.
---
 
<Cards>
  {/* CustomCard here */}
</Cards>

And you are good to go! 🎉

Submitting Your Contribution

Commit Your Changes

Stage and commit your changes:

git add .
git commit -m "add: [website name]"

Push to Your Fork

Push changes to your forked repository:

git push --set-upstream origin add-resource
git push

Create a Pull Request

Create a pull request on the original repository, providing a description of the resource and its benefits. GitHub Docs on Pull Requests

Contribution Guide