Skip to content

Latest commit

 

History

History
91 lines (53 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

91 lines (53 loc) · 2.94 KB

Contributing to Frontend Toolkit

Thank you for considering contributing to the Frontend Toolkit! We appreciate your interest in helping us improve and expand this collection of resources for frontend developers. Whether you have a new resource to add, a suggestion for improvement, or a fix for a bug, your contributions are valuable.

How to Contribute

1. Fork the Repository

Start by forking the repository to your own GitHub account:

  1. Navigate to the Frontend Toolkit GitHub repository.
  2. Click the "Fork" button in the top right corner of the page.

2. Create a New Branch

Clone your forked repository to your local machine and create a new branch:

git clone https://github.com/4trodev/frontend-toolkit
cd frontend-toolkit
git checkout -b feature/add-new-resource

3. Add Your Resource

Add your resource to the appropriate section in the README.md file:

  1. Locate the correct section (e.g., UI Libraries, JS Libraries, etc.) in the README.md.

  2. Add a new entry for your resource following the existing format.

Ensure that you include:

  • Name: The name of the resource.

  • Description: A brief overview of what the resource does.

  • Link: The official website or repository for the resource.

Example:

- **[Resource Name]**: A brief description of the resource. [Resource Link](https://example.com/)

4. Commit Your Changes

Once you've added your resource, commit your changes with a descriptive message:

git add README.md
git commit -m "Add [Resource Name] to [Category]"

5. Push to Your Fork

Push your changes to your forked repository:

git push origin feature/add-new-resource

6. Submit a Pull Request

Open a pull request from your forked repository to the main repository:

  1. Go to the Pull Requests page of the original repository.

  2. Click the "New Pull Request" button.

  3. Select your fork and the feature/add-new-resource branch as the source.

  4. Provide a clear title and description for your pull request.

  5. Submit the pull request for review.

Guidelines

  • Be Clear and Concise: Provide a brief but clear description of the resource you are adding or the changes you are making.

  • Follow the Existing Format: Maintain consistency with the formatting and style used in the README.md.

  • Test Your Changes: If applicable, make sure that your changes don’t break existing content or formatting.

  • Respect the Community: Be courteous and constructive in any discussions or feedback.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue in the Issues section of the repository.

Thank You!

We appreciate your contributions and feedback. Your efforts help us create a valuable resource for the frontend development community.