Skip to content

Latest commit

 

History

History
47 lines (24 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

47 lines (24 loc) · 3.07 KB
Raw

Contributing to Job Metric Domi

Thank you for considering contributing to Domi! We appreciate your interest in making this project better and welcome your contributions.

How to Contribute

We believe that open collaboration leads to the best results. To contribute to the project, follow these steps:

  1. Fork the repository: Fork the Domi repository to your own GitHub account. This will create a copy of the project under your account.

  2. Clone the repository: Clone the forked repository to your local machine using git clone. This allows you to work on the project locally.

  3. Create a branch: Before making any changes, create a new branch in the repository. The branch name should be descriptive and reflect the changes you plan to make.

  4. Make changes: Make your desired changes and improvements to the project. Please ensure that your changes adhere to the coding guidelines and best practices of the project.

  5. Test your changes: Test your changes thoroughly to ensure they work as intended and do not introduce any new issues.

  6. Commit your changes: Once you are satisfied with your changes, commit them with clear and concise commit messages that explain the purpose of the changes.

  7. Pull Request: Push your changes to your forked repository and create a Pull Request (PR) to the main branch of the original Domi repository. Provide a detailed description of the changes you made, the problem you solved, and any other relevant information.

  8. Code Review: The project maintainers will review your Pull Request. Be prepared to make changes or address any feedback you receive during the review process.

  9. Merge: Once your Pull Request has been approved and any necessary changes have been made, it will be merged into the main project. Congratulations on your successful contribution!

Code Style and Guidelines

Please follow the coding style and guidelines of the project. If the project uses a specific coding style (e.g., Python's PEP 8), make sure your contributions comply with it.

Reporting Issues

If you encounter any bugs, have questions, or want to suggest improvements, please create an issue in the GitHub repository. Clearly, describe the problem or suggestion, providing steps to reproduce the issue if applicable.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Be respectful, inclusive, and considerate of others when participating in this project. Any unacceptable behavior will not be tolerated.

License

By contributing to Domi, you agree that your contributions will be licensed under the same license as the project (if applicable). Make sure you understand and comply with the licensing terms before submitting your contributions.

Acknowledgments

Contributors play a vital role in the success of this project. Your efforts will be acknowledged in the project's documentation and release notes, and your GitHub profile will be listed as a contributor.

Thank you for your interest in contributing to Domi. Together, we can build an amazing open-source community and make the project even better!