Thank you for your interest in contributing to AI-QnA! Whether you're fixing a bug, improving the documentation, or adding a new feature, your contributions are highly valued.
Please take a moment to review the following guidelines before getting started.
This project follows the Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to project maintainers.
Ensure that you have the following tools installed on your local machine:
-
Clone the repository:
git clone https://github.com/ashsajal1/ai-qna.git
-
Navigate to the project directory:
cd ai-qna -
Install dependencies:
npm install
If you encounter any bugs or issues, please create a new issue and provide detailed information about the problem, including steps to reproduce.
-
Fork the repository.
-
Create a new branch for your feature or bug fix:
git checkout -b feature-name
-
Make your changes and ensure that the code follows the coding standards.
-
Test your changes locally.
-
Commit your changes and push them to your fork:
git commit -m "Your descriptive commit message" git push origin feature-name -
Create a pull request with a clear title and description.
Follow the TypeScript and Tailwind CSS coding standards defined in the project.
main: The main development branch.- Feature branches: Create a new branch for each feature or bug fix.
Ensure that your code changes pass all existing tests and write new tests if necessary.
Connect with the community and get help on our official Discord channel.
Thank you for contributing to AI-QnA! Your efforts help make this project better for everyone.