Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 3.93 KB
Raw

Contributing to MyLibrary 📚

Welcome to MyLibrary, a modern library management web application built with React.js, Vite, and Tailwind CSS. We're excited to have you as a potential contributor to our project. Whether you're a developer, designer, writer, or anyone enthusiastic about making MyLibrary better, there are numerous ways to get involved.

📝 Table of Contents

🛠️ How to Contribute

Contributions to MyLibrary can encompass various forms, including but not limited to:

  • Code Contributions: Help us develop new features, enhance existing functionality, or fix bugs.
  • Design Contributions: Contribute to the UI and UX design of MyLibrary.
  • Documentation Contributions: Improve our project's documentation for users and contributors.
  • Writing Contributions: Create technical blogs, case studies, or guides related to MyLibrary.
  • Testing Contributions: Assist in identifying and resolving issues through testing.
  • Feedback and Ideas: Share your thoughts, ideas, and feedback in the Discussions section.

🐛 Reporting Issues

If you encounter a bug, have a feature request, or any questions, please create an issue. Be sure to provide detailed information to help us understand and address the issue effectively.

🎉 Hacktoberfest Participation

MyLibrary actively participates in Hacktoberfest, an annual celebration of open-source contributions. Here's how you can join the Hacktoberfest fun with us:

  1. Look for issues labeled as "Hacktoberfest" in our GitHub issue tracker. These are specially curated issues for Hacktoberfest contributors.

  2. Contribute to these issues by following the guidelines mentioned in each issue. You can work on bug fixes, features, or enhancements.

  3. Submit your pull request (PR) with your contribution. Our team will review your PR and provide feedback.

  4. Once your PR is merged, it will count towards your participation in Hacktoberfest. Plus, you'll be helping us improve MyLibrary!

🧰 Coding Guidelines

When writing code for MyLibrary, please follow these guidelines:

  • Maintain the existing coding style and conventions used in the project.
  • Use clear and descriptive variable and function names.
  • Document your code changes, especially if they introduce new functionality.
  • Write tests for new features and ensure all tests pass before submitting a PR.

🔗 Creating Pull Requests

To contribute code to MyLibrary, follow these steps:

  1. Create a new branch for your contribution:
  git checkout -b feature/your-feature-name

  1. Write your code and make regular commits.

  2. Push your branch to your GitHub fork:

  git push origin feature/your-feature-name

  1. Create a pull request (PR) from your branch to the main MyLibrary repository. Ensure your PR includes a clear description of the changes and references any related issues.

  2. Our team will review your PR, provide feedback, and work with you to address any necessary changes.

  3. Once your PR is approved, it will be merged into the main repository

📖 Documentation

Clear and well-structured documentation is essential for MyLibrary. If you're interested in contributing to documentation:

  • Update and improve existing documentation.
  • Create new documentation for features or components.
  • Ensure documentation is accurate and follows best practices.

Feel free to share your thoughts, ask questions, or engage in discussions with other contributors and users. Your feedback plays a vital role in shaping the future of MyLibrary, so don't hesitate to participate in the conversation!