Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (83 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

112 lines (83 loc) · 3.26 KB

Contributing to KALAM

Thank you for your interest in contributing to KALAM! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and considerate of others.

How Can I Contribute?

Code Contributions

  1. Fork the repository
  2. Create a branch for your feature or bugfix: git checkout -b feature/your-feature-name
  3. Make your changes, following the project's coding standards
  4. Commit your changes with a descriptive commit message
  5. Push to your fork: git push origin feature/your-feature-name
  6. Create a Pull Request to the main repository

Content Contributions

  • Add new vocabulary words
  • Provide Quranic examples
  • Create new quizzes
  • Verify translations
  • Improve explanations

Feedback and Ideas

  • Report bugs
  • Suggest new features
  • Provide feedback on existing features
  • Share your learning experience

Community Support

  • Share KALAM with others
  • Write about your experience
  • Create tutorials
  • Answer questions from other users

Development Setup

  1. Clone the repository ``` git clone https://github.com/YOUR-USERNAME/kalam.git cd kalam ```

  2. Install dependencies ``` npm install

    or

    yarn install ```

  3. Run the development server ``` npm run dev

    or

    yarn dev ```

  4. Open http://localhost:3000 in your browser

Pull Request Process

  1. Ensure your code follows the project's coding standards
  2. Update the README.md with details of changes if appropriate
  3. The PR should work in development environment
  4. Your PR will be reviewed by maintainers, who may request changes or provide feedback
  5. Once approved, your PR will be merged

Coding Standards

  • Use TypeScript for all new code
  • Follow the existing code style
  • Write meaningful commit messages
  • Add comments for complex logic
  • Write tests for new features when possible

Questions?

If you have any questions, feel free to reach out to the maintainers:

Thank you for contributing to KALAM! ```

```plaintext file="LICENSE" MIT License

Copyright (c) 2023 KALAM Project Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.