Skip to content

Latest commit

 

History

History
105 lines (68 loc) · 2.99 KB

Contributing.md

File metadata and controls

105 lines (68 loc) · 2.99 KB

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.


Need some help regarding the basics?🤔

Contributing Process 🛠

1. Fork the Repository

  • Fork the repository by clicking the "Fork" button at the top right of the project page.
  • This will create a copy of the repository under your GitHub account.

2. Setup the Project Locally

Clone the project

  git clone https://github.com/ombhojane/explainableai

Go to the project directory

  cd explainableai

Install dependencies

  pip install -r requirements.txt

Environment Values: Add Google's Gemini API key in .env as GOOGLE_API_KEY

Get Started with data.csv dataset or you can have any dataset

  python main.py [dataset] [Target_column]

3.Create a new branch for your feature or bugfix:

git checkout -b my-new-feature

4. Make your changes and commit them with a clear message:

git add .

git commit -am 'Add some feature: X'

5. Push your branch to your forked repository:

git push origin my-new-feature

6. Open a pull request to the main branch of the explainableai repository.

Vola! you just made a contribution.

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


Issue Report Process 📌

  1. Go to the project's issues.
  2. Give proper description for the issues.
  3. Don't spam to get the assignment of the issue 😀.
  4. Wait for till someone is looking into it !.
  5. Start working on issue only after you got assigned that issue 🚀.

Pull Request Process 🚀

  1. Ensure that you have self reviewed your code 😀
  2. Make sure you have added the proper description for the functionality of the code
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

Thank you for contributing💗