Skip to content

Contributing Guide

🤝 How to Contribute

We welcome contributions to enhance the AI and GitLab development environment. Here’s how you can get involved:

📥 Submitting Issues

  1. Search Existing Issues

  2. Before submitting a new issue, check the existing issues to avoid duplicates.

  3. Create a New Issue

  4. When reporting a bug or requesting a feature, please be as detailed as possible.
  5. Use the provided issue templates to ensure all necessary information is included.

🛠️ Pull Requests

  1. Fork the Repository

  2. Fork the repository to your GitHub account and clone it to your local machine.

  3. Create a Branch

  4. Create a new branch for your work.

  5. Branch naming conventions:

    • Bug fixes: fix/your-branch-name
    • Features: feat/your-branch-name

  6. Make Changes

  7. Make your changes or additions.
  8. Ensure code follows the project's coding standards.

  9. Add tests where applicable.

  10. Run Tests

  11. Ensure all tests pass locally before submitting a pull request.

  12. Document Changes

  13. Update documentation to reflect any changes.

  14. Submit Pull Request

  15. Submit the pull request against the main branch.

  16. Fill out the pull request template with details of your changes.

  17. Address Feedback

  18. Be responsive to feedback and update your pull request as needed.

💬 Communication

  • Join our project Slack channel or discussion forums for real-time collaboration.
  • Participate in bi-weekly stand-up meetings to stay updated.

📝 Code of Conduct

  • We expect all contributors to adhere to the project's Code of Conduct.
  • Be respectful to each other and maintain a collaborative environment.

🎉 Thank You!

We appreciate your contributions and effort to improve the AI and GitLab development environment. Together, we can make a significant impact!