Skip to content

Latest commit

 

History

History
63 lines (32 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

63 lines (32 loc) · 1.71 KB

Contribution Guide

Thanks for considering a contribution to this project. Whether you're fixing bugs, adding features, or updating documentation, your effort is appreciated.

For New Contributors

If this is your first time, welcome! The codebase is documented to help you get started.

Test Environment

Ensure you run tests in the provided notebook to validate your changes without causing regressions.

Contribution Workflow

  1. Fork the Repository

    Click the fork button to create your personal copy.

  2. Clone the Repository

    git clone https://github.com/mohamed-chs/chatgpt-history-export-to-md.git

  3. Create a New Branch

    Navigate to your directory and create a branch:

    git checkout -b branch-name

  4. Make Your Changes

    Update the code or documentation as needed.

  5. Commit Your Changes

    git commit -m "Brief description of changes"

  6. Push to Your Fork

    git push origin branch-name

  7. Create a Pull Request

    Navigate to the repository and submit a PR. Attach any relevant images or demos to facilitate the review process.

Suggestions

Check the Issues tab for bugs, enhancements, or first-timer tasks. If you have a new idea or improvement, feel free to open an issue.

The Project Todo and JavaScript Todo also offer areas needing attention.

Documentation

Refer to the in-code comments and docstrings for understanding and clarity.

Code of Conduct

Maintain a respectful and professional demeanor. Constructive collaboration is key.

Final Note

Each contribution, irrespective of its scale, is valuable. Dive in and make a difference!

Looking forward to your pull request.