Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 2.39 KB
Raw

Contributing to AI-Research-Paper-Explainer

First off, thank you for considering contributing to AI-Research-Paper-Explainer! It's people like you that make this tool a great resource for the research community.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [rdserendipity1411@gmail.com].

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with a clear title and detailed description of the suggested enhancement.
  • Explain why this enhancement would be useful to most AI-Research-Paper-Explainer users.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Development Setup

  1. Fork the AI-Research-Paper-Explainer repository.
  2. Clone your fork locally: 
    git clone https://github.com/rd-serendipity/ai-research-paper-explainer.git
cd ai-research-paper-explainer
  3. Create a branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  4. Make your changes and commit them with a clear commit message.
  5. Push your branch to your fork on GitHub.
  6. Open a pull request from your branch to the main AI-Research-Paper-Explainer repository.

Coding Style

  • Follow PEP 8 guidelines for Python code.
  • Use meaningful variable and function names.
  • Comment your code where necessary, especially for complex logic.

Testing

  • Add unit tests for new features or bug fixes.
  • Ensure all tests pass before submitting a pull request.

Documentation

  • Update the README.md if you change functionality.
  • Document new features or changes in behavior.

Thank you for your contributions to AI-Research-Paper-Explainer!