Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 2.12 KB
Raw

Contributing to FairGrade.AI

Thank you for your interest in contributing to FairGrade.AI! We welcome contributions from the developer community to help improve and enhance our project. Whether you want to fix a bug, add a new feature, or suggest improvements, your contributions are highly appreciated.

To ensure a smooth and collaborative experience, please follow these guidelines when contributing to FairGrade.AI:

Getting Started

  1. Fork the FairGrade.AI repository to your own GitHub account.
  2. Clone the repository to your local machine.
  3. Create a new branch for your changes: git checkout -b my-branch.
  4. Make your desired changes to the codebase.
  5. Test your changes thoroughly to ensure they work as expected.
  6. Commit your changes: git commit -m "Your commit message".
  7. Push your changes to your forked repository: git push origin my-branch.
  8. Open a pull request from your forked repository to the main FairGrade.AI repository.

Code Style and Standards

  • Follow the existing code style and conventions in the project.
  • Write clear and concise code with proper documentation and comments.
  • Ensure that your changes do not introduce any linting or formatting errors.

Testing

  • Include appropriate tests for your changes to maintain code quality.
  • Run the existing test suite to ensure that your changes do not break any existing functionality.

Reporting Bugs

If you encounter any bugs or issues in FairGrade.AI, please open a new issue in the GitHub repository. Provide a clear and detailed description of the problem, including steps to reproduce it and any relevant error messages.

Feature Requests

We welcome ideas and suggestions for new features or improvements. If you have an idea for enhancing FairGrade.AI, open a new issue in the GitHub repository and describe your feature request. Be as clear and specific as possible about the functionality you envision.

Communication

Feel free to join our Discord channels to discuss your ideas, ask questions, or seek assistance from other contributors. We value an open and collaborative environment and encourage respectful and constructive communication.