Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

43 lines (34 loc) · 2.65 KB

Contributing to the Web Language Proficiency Tester

Welcome!

We're excited that you're interested in contributing to the Web Language Proficiency Tester! We welcome contributions from all, regardless of your level of experience. This document provides guidelines and information on how you can contribute to the project.

Ways to Contribute

There are many ways you can contribute to our project:

  • Bug Reports: Identify and report bugs in the project.
  • Feature Suggestions: Suggest new features or enhancements.
  • Documentation: Help improve or translate the documentation.
  • Code Contributions: Submit bug fixes or feature implementations.

Getting Started

  1. Fork the Repository: Start by forking the repository and then cloning your fork locally.
  2. Set Up Your Environment: Follow the setup instructions in the INSTALL.md to get your development environment ready.
  3. Find an Issue: Look for open issues that you are interested in. Feel free to ask for clarification or guidance if needed.

Making Changes

  • Create a Branch: For each new feature or fix, create a new branch based on main.
  • Make Your Changes: Implement your feature or fix.
  • Write or Adapt Tests: Ensure your changes are tested, as this helps prevent future regressions.
  • Follow Code Style and Conventions: Ensure your code adheres to the established style and conventions.
  • Document Your Changes: Update the documentation to reflect your changes, if applicable.

Submitting a Pull Request

  • Push Your Changes: Push your changes to your fork on GitHub.
  • Create a Pull Request: From your fork, submit a pull request to the main repository. Provide a descriptive title and a detailed description of your changes.
  • Code Review: Wait for a code review. Participate in the discussion and make any necessary changes.

Code Review Process

Our project maintainers review pull requests on a regular basis. During the review process, we might suggest some changes, improvements, or alternatives. Some things we look for are:

  • Quality: Code is well-written and understandable.
  • Compatibility: Changes do not break existing functionalities.
  • Tests: Changes are well-tested and pass all existing tests.

Community

  • Respect: Treat everyone with respect. Our community strives to be welcoming and inclusive.
  • Communication: Keep communication clear and constructive.

Thank you for your interest in contributing to the Web Language Proficiency Tester. Your contributions help make our project even better!

Contact

If you have any questions, please submit them as issues on GitHub.