Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 5.13 KB

CONTRIBUTING.md

File metadata and controls

86 lines (56 loc) · 5.13 KB
Raw

Contributing Guidelines

Welcome!

We're excited that you're interested in contributing to our open-source project. Whether you're new to open source or an experienced developer, we want your contributions to be smooth and enjoyable. Below, you'll find some guidelines and tips to help you get started.

Please adhere to and review our Code Of Conduct.

Important Rules

To ensure a smooth experience, please follow these important rules:

  1. Relevance: Ensure that the resource you're adding aligns with the appropriate category. Web development resources belong in the web development category, UI/UX design resources in the UI/UX design category, and so forth. Additionally, ensure that your resource aligns with the specific section of the category. For example, if you have a resource named "anime.js", it should be placed in the web development category under the animation section. This precision ensures that users can easily locate and benefit from the resources in their intended context.
  2. Use the PR Template: When you create a pull request (PR), please make sure to carefully follow and review the provided PR template. This ensures a structured and efficient collaboration process.

How to Add a Resource

URL Format: When adding a resource, follow this format:

<a href="URL_here">Resource Name</a>

Example:

### Section name
<table width="100%">
 <tr>
   <th>Resource Name</th>
   <th>Description</th>
 </tr>
 <tr>
   <td><a href="URL HERE">RESOURCE NAME</a></td>
   <td>RESOURCE DESCRIPTION</td>
 </tr>
</table>

Note: Replace "URL_here" with the actual resource URL and provide a brief description.

By following these rules, you will help maintain consistency and clarity in our repository.

How to Contribute

There are many ways to contribute, and you don't need to be a coding wizard to get involved. Here are some beginner-friendly ways to contribute:

Share Your Ideas

We value your input, whether it's proposing a new section to a category, suggesting additional categories, or sharing any ideas for the project's enhancement.

Here's how you can contribute your ideas:

  1. Raise an Issue: Start a discussion by creating an issue. Describe your idea, and I'll review it if it aligns to the project's goal.
  2. Direct Message: Feel free to reach out to me personally. You can connect with me on LinkedIn or reach out via Twitter.

Add Valuable Resources

If you come across a resource that you believe would benefit others, we encourage you to share it with us. Here's how you can contribute valuable resources:

  1. Review the Rules for Adding Resources: Carefully read and understand the guidelines on how to add a resource, including the specified format. Ensure that you follow the provided PR template, as it streamlines the review process for us.

  2. Raise a PR: If you want to add a resource, you can create a Pull Request (PR) directly.

Please include the following details in your PR:

  • Resource URL
  • Description of the resource
  • Section and category where you plan to add it (For example, category could be Web Development and section is Tools)

Grammatical Errors

Help us maintain clean and error-free content by fixing typos or grammar issues. Your attention to detail ensures a seamless reading experience for everyone involved.

  1. Create a PR: If you notice any grammatical errors or typos, please create a Pull Request (PR) directly. Your contributions help us maintain the quality and accuracy of our project.

Enhance Documentation

Improving our project documentation is crucial for creating a user-friendly experience. If you have ideas on how to enhance the current documentation, please share them.

  1. Raise an Issue: Start a discussion about your documentation improvement ideas. Perhaps you've identified areas where we can enhance the documentation for a better user experience, making it more user-friendly and accessible. Share your insights to help us continually improve.

Report Outdated or Broken Links

Help us maintain the reliability of our resources by reporting any broken links or outdated information.

  1. Create a PR: If you come across outdated or broken links, please create a Pull Request (PR) directly. Include details on the category or location where you found the issue. This will help us swiftly address and update the information.

Thank you for considering contributing to ResourceHub! Your contributions play a crucial role in making this project a valuable resource for the web development community. 🌐✨

Happy contributing! 🚀