Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

25 lines (13 loc) · 1.46 KB

Contributing to databricks_helpers 👷🏾‍♀️

Contribution Guidelines

  • 🍴 Fork the Repository: Start by forking the repository to make your contributions.

  • 🌲 Create a New Branch: Always create a new branch for your contributions (git checkout -b feature-branch).

  • 🔐 Handle Secrets Carefully: Ensure that Databricks secrets, tokens, cluster configurations, or hostnames are never exposed publicly.

  • 📙 Export as .ipynb: Ensure that Databricks notebooks are exported as .ipynb files.

  • 📃 Ensure Relevance: Contributions should be directly related to Databricks, offering unique insights not found in official documentation or other common repositories.

  • 🔖 Document Your Code: Ensure your code is well-documented, explaining the purpose and functionality of your contribution.

  • 🧑🏻‍💻 Follow Coding Conventions: Ensure your code aligns with existing coding conventions for consistency and readability. Format your code cells. Our team can assist with this during PR review.

  • 🔨 Test Your Code: Ensure your code is thoroughly tested to maintain the repository's quality and reliability.

  • 🎫 Submitting Issues: Feel free to submit issues and enhancement requests, ensuring they are well-described and labeled.

  • 🤝 Submitting Pull Requests: Make sure your code is in a new branch and submit a pull request, ensuring it's well-described.

Thank you for contributing to databricks_helpers! ❤️