Skip to content

Latest commit

 

History

History
71 lines (57 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

71 lines (57 loc) · 2.32 KB

Contributing to Japanese Learning App

Thank you for considering contributing to our project! We welcome developers, designers, and enthusiasts to collaborate and help us build a dynamic and impactful application. Follow the guidelines below to get started.

How to Contribute

1. Fork the Repository

  • Fork the repository to your GitHub account.
  • Clone your fork locally: 
    git clone https://github.com/your-username/Japanese-Learning-App.git

2. Set Up the Environment

  • Ensure you have Python 3.8+ installed.
  • Install dependencies: 
    pip install -r requirements.txt
  • Run the app locally: 
    streamlit run app.py

3. Pick an Issue

  • Check the Issues section.
  • Comment on the issue you’d like to work on to get it assigned.
  • If you have a new idea or feature in mind, feel free to open a new issue for discussion.

4. Create a Branch

  • Create a feature branch for your work: 
    git checkout -b feature/your-feature-name

5. Make Changes

  • Write clean, readable, and well-documented code.
  • Follow the existing project structure and coding conventions.
  • Test your changes locally before committing.

6. Commit Your Changes

  • Commit with a meaningful message: 
    git add .
git commit -m "Add feature: description of your feature"

7. Push and Create a Pull Request

  • Push your changes to your fork: 
    git push origin feature/your-feature-name
  • Go to the original repository and create a pull request (PR).
  • Add a clear description of your changes in the PR.

8. Address Feedback

  • Review comments will be provided on your PR.
  • Make necessary changes and push them to your branch.

Code of Conduct

We value a collaborative and respectful environment. Please review our Code of Conduct before contributing.

Contribution Tips

  • Keep commits small and focused.
  • Document new features and code changes where necessary.
  • Follow best practices for Python and Streamlit development.

Need Help?

If you have any questions or need assistance, feel free to reach out by opening an issue or discussing it in the repository’s discussion section.

We look forward to your contributions! 🚀