HyderabadIndiaChapter_ChatbotInterviewPreparation/CONTRIBUTING.md

Contributing to Hyderabad, India Chapter - Chatbot for Interview Preparation using NLP

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer

We Develop with Dagshub and HuggingFace

We use Dagshub to host code, track issues and feature requests, as well as accept pull requests. We also use HuggingFace to host our models and datasets.

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your branch from main.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

Any contributions you make will be under the MIT Software License

Report bugs using Dagshub's issues

We use Dagshub's issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from a project where I contribute.

Great Bug Reports tend to have:

• A quick summary and/or background
• Steps to reproduce
  • Be specific!
  • Give sample code if you can.
• What you expected would happen
• What actually happens
• Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

• 4 spaces for indentation rather than tabs
• You can try running black --line-length 120 for style unification
• You can also try running flake8 for linting

License

References