CONTRIBUTING.md

Contribution Guide

We encourage contributions to reDocs.ai! Here's how you can get involved:

Creating Issues

Before you submit an issue, please do a search in open issues to see if the issue or feature request has already been filed. Fill in with as much detail as possible. The more detail you provide, the more likely that someone can help you.

Submitting Pull Requests

If you're working on an existing issue, respond to the issue and express interest in working on it. This helps other people know that the issue is active, and hopefully prevents duplicated efforts.

To submit a pull request, follow the following steps:

• Clone the repository.
• Create a new branch from main.
• Once you're satisfied with your changes, add your changes to your branch and commit them with a descriptive commit message. Additionally make sure to read this doc to follow a similar commit discipline.
• Push your branch and submit a pull request to the main branch.
• Await review. Respond to any comments or requests made by reviewers.

Code of Conduct:

• Write clear and concise code that follows the project's style guide.
• Include unit tests for your code.
• Document your code with comments and docstrings.
• Follow the Pull Request Template when submitting your changes.
• Be respectful and collaborative in your communication with other contributors.
• We appreciate your interest in contributing to reDocs.ai!

PR Template

Please follow this template when submitting a pull request to reDocs.ai:

1. Title:

• Keep it concise and descriptive of the changes you made.
• Use the format: [Feature/Bug Fix/Improvement] - Descriptive title.

2. Description:

• Clearly explain the purpose of your change.
• Include relevant details about the functionality you added, the bug you fixed, or the improvement you implemented.
• Reference any issues your pull request addresses.
• Explain why your changes are necessary and how they benefit the project.

3. Checklist:

• I have read and followed the Contributing Guide.
• I have written unit tests for my changes.
• My code follows the project's style guide.
• I have updated the documentation (if applicable).
• I have added a clear and descriptive commit message.

4. Screenshots/Videos (optional):

• If your changes involve a visual element, please include screenshots or videos demonstrating the functionality.

5. Additional Information:

• Mention any relevant discussions or decisions made regarding your changes.
• Feel free to ask questions or provide additional context if needed.

Git Workflow:

We encourage contributors to follow a git rebase workflow. This workflow provides several benefits, including:

1. Clean commit history: Rebasing keeps the commit history linear and easy to understand.

2. Prevents conflicts: Rebasing helps avoid merge conflicts that can occur when merging branches.

3. Easier integration: Rebasing ensures your changes are integrated seamlessly with the latest upstream changes.

Here are some resources to learn more about git rebase:

• A Git Workflow Using Rebase

• Get a clean git history with a rebase workflow