Skip to content

Latest commit

 

History

History
99 lines (70 loc) · 3.56 KB

CONTRIBUTION.md

File metadata and controls

99 lines (70 loc) · 3.56 KB

Contribution Guidelines for niceML 🍦

Hello and welcome to the niceML community! We're thrilled that you want to contribute to our project. Here are some guidelines to help you get started and make your contribution smooth and enjoyable. 🚀

Table of Contents

Code of Conduct

Please review and adhere to our Code of Conduct to ensure a positive and inclusive community.

How to Contribute

Reporting Bugs

If you encounter a bug, please open an issue and provide detailed information about the problem, including steps to reproduce.

Feature Requests

We welcome your ideas for new features! Feel free to submit a feature request and outline the functionality you'd like to see.

Pull Requests

  1. Fork the repository and create a branch for your feature or bug fix.
  2. Make your changes and ensure that tests pass.
  3. Submit a pull request with a clear and concise description of your changes following our Pull Request Template.
  4. There is a Checklist in the Pull Request Template. Please ensure that you follow the checklist where appropriate.
  5. If the Git history contains only conventional commits, your code contribution will be rebased.
  6. If the Git history contains at least one commit that isn't a conventional commit your code contribution will be squashed with a single conventional commit.

Setting Up Your Development Environment

To set up your local development environment, follow the instructions in Development Environment Setup.

Coding Standards

Please adhere to our coding standards to maintain a consistent codebase.

Commit Guidelines

Follow our commit guidelines when making changes. This helps keep our commit history clean and meaningful.

Branching Strategy

We use the Gitflow branching model. Ensure your branch names align with the conventions outlined there.

Documentation

Improvements to documentation are always appreciated. Please submit documentation changes along with your code changes. We are using mkdocs to create the niceML documentation. Please use Markdown to create new documentation pages and add it inside the docs folder. Make sure to add the file in the SUMMARY.md file, so it can will be displayed on the website.

Community

Connect with other contributors and users in our discussion section. Feel free to ask questions or share your experiences. If you want to directly connect with us, write an Email to [email protected].

Acknowledgments

A big thanks to all contributors who help make niceML even better!

Thank you for being part of the niceML community! 🙌🎉