Skip to content

contributing.md

Latest commit

 

History

History
60 lines (48 loc) · 2.63 KB

contributing.md

File metadata and controls

60 lines (48 loc) · 2.63 KB

Contributing to College Dropout Prediction Model

Thank you for your interest in contributing to this project! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. Before you start contributing, please take a moment to read through these guidelines.

How to Contribute

1. Fork the Repository

  1. Fork this repository by clicking the "Fork" button at the top of this page.
  2. Clone your fork to your local machine: 
    git clone https://github.com/simran50/Dropout_Prediction.git
  3. Create a new branch for your changes: 
    git checkout -b your-branch-name

2. Make Changes

  • Ensure that your changes are aligned with the project’s goals.
  • For major changes, please open an issue first to discuss what you would like to change.
  • When writing code, make sure your code is clean and follows good coding practices.
  • Add tests or update the existing tests if necessary.
  • Ensure your changes do not break the existing codebase.

3. Commit Changes

  1. Once your changes are ready, commit them to your branch: 
    git add .
git commit -m "A brief description of your changes"
  2. Push your branch to your forked repository: 
    git push origin your-branch-name

4. Create a Pull Request

  1. Navigate to the original repository.
  2. Click on the "Pull Request" button.
  3. Choose the branch you created, provide a descriptive title, and explain your changes in detail.
  4. Submit your pull request.

5. Wait for Review

Once you submit your pull request, it will be reviewed. You may be asked to make changes based on the review. Once the review process is complete, your pull request will be merged into the main repository.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Reporting Issues

If you encounter any issues while working on this project, please feel free to open an issue. Be sure to provide as much detail as possible.

Guidelines

  • Write clear, concise commit messages.
  • If you are fixing a bug, include the issue number in your commit message.
  • Follow the existing code style, and document your code where necessary.
  • Respect the code of conduct and be kind in all communications.

Getting Help

If you have any questions, feel free to reach out by opening a new discussion or emailing me at [simransaloni5060@gmail.com].

We appreciate your time and effort in making this project better! 🚀