Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

72 lines (47 loc) · 3.08 KB
Raw

Contributing to Arutairu

Thank you for your interest in contributing to Arutairu! Together, we can make learning Japanese a more enjoyable experience for everyone.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue. Make sure to include detailed information such as:

  • A descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages, if applicable
  • Your environment (OS, device, version of the app, etc.)

Suggesting Features

We welcome feature suggestions! To propose a new feature:

  1. Open an issue with the label "Feature Request".
  2. Describe the feature in detail, including why it would be useful.
  3. If possible, provide examples or mockups to illustrate your suggestion.

Submitting Changes

We appreciate your help in improving Arutairu! Here’s how you can submit your changes:

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page to create your copy of the project.
  2. Clone Your Fork: Clone your forked repository to your local machine using: git clone https://github.com/yourusername/arutairu.git
  3. Create a Branch: Create a new branch for your changes. Use a descriptive name for your branch: git checkout -b feature/your-feature-name
  4. Make Your Changes: Implement your changes in this branch. Follow the coding guidelines and ensure your code is well-documented.
  5. Commit Your Changes: Write clear, concise commit messages for your changes: git commit -am 'Add some feature'
  6. Push to Your Fork: Push your changes to your forked repository: git push origin feature/your-feature-name
  7. Open a Pull Request: Go to the original repository and open a pull request. Provide a clear and descriptive title and include any relevant information about your changes.

Code Review Process

All submissions, including pull requests, will undergo a review process. Be prepared to make adjustments based on feedback. The review process ensures that:

  • Code quality is maintained
  • Changes align with the project’s goals and guidelines
  • No breaking changes are introduced

Coding Guidelines

To maintain consistency across the project, please follow these coding guidelines:

  • Style: Follow the existing code style. Use appropriate naming conventions, indentation, and spacing.
  • Documentation: Document your code thoroughly. Include comments where necessary and update the project’s documentation if your changes affect it.
  • Testing: Ensure your code is tested. Add unit tests for new functionality and ensure existing tests pass.

Community Guidelines

We strive to create a welcoming and inclusive environment. Please adhere to our Code of Conduct in all your interactions.

Acknowledgements

We appreciate all contributions, big or small. Your efforts help make Arutairu better for everyone.

Contact

If you need any help or have questions, feel free to join the discussion on our GitHub page.

Thank you for so much your contributions!