Skip to content

Latest commit

 

History

History
96 lines (50 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

96 lines (50 loc) · 4.23 KB
Raw

Contributing Guidelines

Thank you for considering contributing to our project! Here are some guidelines to help you get started.

Project Overview

Our project aims to build a question answering model using the Transformers library from Hugging Face. We download and preprocess data from Wikipedia using natural language processing techniques and transformer-based models, fine-tune a pre-trained transformer model on the data, and generate answers to a set of predefined questions using the trained model.

How to Contribute

We welcome contributions from the community! Here are some ways you can contribute:

Reporting Issues

If you encounter any issues while using our project, please report them on our GitHub Issues page. Please include a detailed description of the issue, steps to reproduce it, and any relevant screenshots or error messages.

Fixing Bugs

If you would like to fix a bug, please follow these steps:

  1. Find an open issue on our GitHub Issues page that you would like to fix.

  2. Comment on the issue that you would like to work on it, and wait for confirmation from a project maintainer.

  3. Fork the repository and clone it to your local machine.

  4. Create a new branch with a descriptive name for the bug fix (e.g., "fix-broken-link").

  5. Make the necessary code changes to fix the bug.

  6. Write tests for the bug fix.

  7. Push the changes to your forked repository.

  8. Create a pull request from your forked repository to our main repository.

  9. Wait for review from a project maintainer. Address any feedback and make additional changes as necessary.

  10. Once your pull request is approved and merged, your changes will be included in the next release of the project.

Adding Features

If you would like to add a new feature to our project, please follow these steps:

  1. Find an open issue on our GitHub Issues page that describes the feature you would like to add.

  2. Comment on the issue that you would like to work on it, and wait for confirmation from a project maintainer.

  3. Fork the repository and clone it to your local machine.

  4. Create a new branch with a descriptive name for the new feature (e.g., "add-search-functionality").

  5. Make the necessary code changes to add the new feature.

  6. Write tests for the new feature.

  7. Push the changes to your forked repository.

  8. Create a pull request from your forked repository to our main repository.

  9. Wait for review from a project maintainer. Address any feedback and make additional changes as necessary.

  10. Once your pull request is approved and merged, your changes will be included in the next release of the project.

Contributing to Documentation

If you would like to contribute to the project's documentation, please follow these steps:

  1. Fork the repository and clone it to your local machine.

  2. Create a new branch with a descriptive name for your documentation changes (e.g., "update-readme").

  3. Make the necessary changes to the documentation.

  4. Push the changes to your forked repository.

  5. Create a pull request from your forked repository to our main repository.

  6. Wait for review from a project maintainer. Address any feedback and make additional changes as necessary.

  7. Once your pull request is approved and merged, your changes will be included in the next release of the project.

Code of Conduct

We want our project to be an open and welcoming community for everyone. To achieve this, we ask that all contributors follow our Code of Conduct. This includes:

  • Being respectful and considerate of others' opinions, experiences, and backgrounds.
  • Refraining from discriminatory language or behavior.
  • Being open to feedback and constructive criticism.
  • Reporting any Code of Conduct violations to the project maintainers.

If you have any questions or concerns about the Code of Conduct, please contact the project maintainers.

Attribution

This Contributing Guidelines document was adapted from the Contributing Guidelines template by nayafia.