Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (34 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

55 lines (34 loc) · 2.98 KB

Contributing to Churnobyl

Welcome to the Churnobyl! We are thrilled that you are interested in contributing. Your contributions will play a significant role in helping us predict churn in a telecom company more effectively.

To get started, please follow the guidelines below:

How to Contribute

  1. Fork the Repository: Start by forking this repository to your GitHub account. This will create a copy of the project that you can work on.

  2. Clone the Repository: Clone the forked repository to your local machine using the following command:

    git clone https://github.com/ishandandekar/Churnobyl

  3. Create a Branch: Create a new branch on your local repository to work on your changes. Use a descriptive name for the branch that reflects the changes you intend to make.

  4. Make Changes: Implement the changes, improvements, or bug fixes to the codebase. Ensure that your changes are well-documented and follow the coding standards of the project.

  5. Test Your Changes: Before submitting a pull request, make sure that your code is thoroughly tested. Verify that it doesn't introduce any regressions and works as expected.

  6. Commit and Push: Once you are satisfied with your changes, commit your changes and push them to your forked repository.

    git add .
git commit -m "Your descriptive commit message"
git push origin your-branch-name

  7. Create a Pull Request (PR): Go to the original repository on GitHub and click on the "New Pull Request" button. Compare your changes with the main branch of the original repository, then submit the PR. Provide a clear and concise description of the changes you made.

  8. Code Review: Your PR will be reviewed by the project maintainers. Be prepared to respond to feedback and make necessary adjustments to your code.

  9. Merge: Once your PR is approved, it will be merged into the main branch. Congratulations! Your contributions are now part of the project.

Code Style Guidelines

Please adhere to the following code style guidelines:

  • Use meaningful variable and function names.
  • Write docstrings and comments to explain complex logic or algorithms.
  • Follow PEP8 guidelines for Python code.
  • Make sure there are no unnecessary imports or unused variables/functions.

Reporting Issues

If you encounter any bugs, have questions, or want to suggest improvements, please feel free to open an issue in the GitHub repository. Provide as much detail as possible to help us understand the problem or suggestion.

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please be respectful and considerate of others while contributing to this project.

Happy contributing!

Note: The above template is just a starting point, and you can modify it to suit the specific needs of your project. Include any additional guidelines, instructions, or specific requirements relevant to your MLOPs churn prediction project.