Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 3.89 KB

contribution.md

File metadata and controls

75 lines (55 loc) · 3.89 KB
Raw

Contribution Guide

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

  1. Fork the Repository: Before making any changes, create a fork of the reDocs.ai repository on GitHub. This allows you to work on your own copy of the code without affecting the main project.

  2. Branch for Your Contribution: Create a new branch for your specific contribution using git checkout -b <branch-name>. This helps keep the main branch clean and facilitates reviewing and merging your changes.

  3. Implement Your Changes: Make your changes to the code, following the project's coding style and best practices. We encourage you to write unit tests for your code to ensure its functionality and stability.

  4. Commit Your Changes: 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.

  5. Create a Pull Request: Create a pull request from your branch to the main branch of the reDocs.ai repository. Be sure to include a detailed description of your changes and any relevant testing results.

  6. Respond to Feedback: The maintainers will review your pull request and provide feedback. Be prepared to answer questions, address concerns, and make adjustments to your code as needed.

  7. Get Merged!: Once your pull request is approved, it will be merged into the reDocs.ai codebase. Your contributions will be available to everyone using the project!

Contribution Guidelines:

  • 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.
  1. 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.
  1. 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.
  1. Screenshots/Videos (optional):
  • If your changes involve a visual element, please include screenshots or videos demonstrating the functionality.
  1. 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: