Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

98 lines (72 loc) · 4.88 KB

Contributing to RepoSavant

Welcome to RepoSavant, an innovative GitHub analytics tool designed to elevate your GitHub experience. We're thrilled that you're interested in contributing to our project! Whether you're a developer, designer, or documentation enthusiast, there are many ways to get involved and help make RepoSavant even better.

📝 Table of Contents

🛠️ How to Contribute

Contributions to RepoSavant can take many forms, including:

  • Code Contributions: Help us develop new features, improve existing functionality, or fix bugs.
  • Design Contributions: Contribute to the user interface (UI) and user experience (UX) design.
  • Documentation Contributions: Improve our project's documentation.
  • Writing Contributions: Write technical blogs, case studies, or guides related to RepoSavant.
  • Testing Contributions: Help us identify and resolve 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 have any questions, please create an issue. Make sure to provide detailed information to help us understand and address the issue effectively.

🎉 Hacktoberfest Participation

RepoSavant 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 RepoSavant!

💻 Development Setup

To set up a development environment for RepoSavant, follow these steps:

  1. Fork the RepoSavant repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/kartikeymish/RepoSavant.git

  3. Install the necessary dependencies:

pip install -r requirements.txt
  1. Create a virtual environment (recommended):
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate
  1. Start contributing by working on existing issues or creating new features!

🧰 Coding Guidelines

When writing code for RepoSavant, please follow these guidelines:

  • Adhere to the PEP 8 style guide for Python code.
  • Use clear and descriptive variable and function names.
  • Include docstrings for functions and modules to provide clear documentation.
  • Write tests for new features and ensure all tests pass before submitting a PR.

🔗 Creating Pull Requests

To contribute code to RepoSavant, 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 RepoSavant 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 crucial for RepoSavant. 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.

💬 Feedback and Discussion

Have ideas or suggestions for RepoSavant? Want to discuss features or improvements? Join the conversation in the Discussions section. We value your feedback and contributions to the project.

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 RepoSavant, so don't hesitate to participate in the conversation!