Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.26 KB
Raw

Contributing to FAQ Accordion

Thank you for your interest in contributing to the FAQ Accordion project! We welcome contributions and appreciate your effort to make this project better. This guide will help you get started with contributing.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please open an issue on our GitLab repository. Provide a clear description of the problem or the feature you would like to see, and if possible, include steps to reproduce the issue.

Submitting Pull Requests

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page to create a personal copy of the repository.

  2. Clone Your Fork: Clone your forked repository to your local machine:

    git clone https://gitlab.com/Yashi-Singh-9/faq-accordion.git

  3. Create a New Branch: Create a new branch for your changes:

    git checkout -b your-branch-name

  4. Make Changes: Make your changes to the codebase. Ensure that your code adheres to the project's coding standards and style.

  5. Test Your Changes: Make sure to test your changes thoroughly. Ensure that everything works as expected and no new issues are introduced.

  6. Commit Your Changes: Commit your changes with a clear and descriptive message:

    git add .
git commit -m "Description of your changes"

  7. Push Your Changes: Push your changes to your forked repository:

    git push origin your-branch-name

  8. Create a Pull Request: Go to the original repository on GitLab and open a new merge request. Provide a clear description of your changes and link to any relevant issues.

Coding Standards

  • HTML: Use semantic HTML5 elements where applicable.
  • CSS: Follow the project's styling guidelines. Use CSS custom properties and ensure responsiveness.
  • JavaScript: Write clean, readable code. Use ES6+ features and ensure that the code is accessible and performs well.

Additional Notes

  • Ensure your changes are well-documented.
  • Add or update tests as necessary.
  • Keep your contributions focused and incremental.

Thank you for contributing to the FAQ Accordion project! Your help is greatly appreciated.