Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (46 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

58 lines (46 loc) · 2.14 KB

Contributing to Docuglean

We love your input! We want to make contributing to Docuglean as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Better documentation
  • Becoming a maintainer

If this is your first contribution to an Open Source project or you're a core maintainer of multiple projects, your time and interest in contributing to this project is most welcome.

How to contribute

This project follows a Fork/Feature Branch/Pull Request workflow. Here's how it works:

  1. Fork the project: Create a personal copy of the repository on your GitHub account.
  2. Clone your fork: Bring a copy of your fork to your local machine. 
    git clone https://github.com/YOUR_USERNAME/docuglean.git
  3. Create a new branch: Start a new branch for your changes 
    git checkout -b feature/your-feature-name
  4. Make your changes: Implement the changes you wish to contribute.
  5. Push your changes: Upload your changes to your fork. 
    git push -u origin feature/your-feature-name
  6. Create a pull request: Open a new GitHub pull request with the patch against the main branch.
    • Use semantic commit conventions (e.g. feat: add new feature, fix: correct issue with X)
    • Include a clear description of your changes
    • Reference any relevant issues

Types of Contributions

  • Small changes (< 3 lines): Feel free to submit directly
    • Typo fixes
    • Documentation updates
    • Simple bug fixes
  • Larger changes (> 3 lines): Please open an issue first
    • New features
    • API changes
    • Major refactoring

Thank you!

Need Help?

This is an open source project, with an open and welcoming community that is always keen to welcome new contributors.

  • GitHub Issues: For bug reports and feature discussions
  • Email: Feel free to contact dean@docuglean.com
  • Documentation: Check our documentation page
  • Community: Join our community forums

Your contributions help make Docuglean better!