{"id":30895557,"url":"https://github.com/ladybug-tools/contributing","last_synced_at":"2025-09-08T22:07:34.149Z","repository":{"id":150368154,"uuid":"114176456","full_name":"ladybug-tools/contributing","owner":"ladybug-tools","description":"Guidelines for contributing to Ladybug Tools projects ","archived":false,"fork":false,"pushed_at":"2021-09-21T16:05:49.000Z","size":8,"stargazers_count":7,"open_issues_count":2,"forks_count":2,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-01-24T11:44:26.997Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ladybug-tools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-12-13T22:43:07.000Z","updated_at":"2023-03-19T09:16:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"ae2aea19-f5f2-43a4-8466-4ee6e55d696b","html_url":"https://github.com/ladybug-tools/contributing","commit_stats":{"total_commits":5,"total_committers":3,"mean_commits":"1.6666666666666667","dds":0.4,"last_synced_commit":"64e61b7c9a3f451b9c8c5b8689ac2be7f577d06d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ladybug-tools/contributing","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fcontributing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fcontributing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fcontributing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fcontributing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ladybug-tools","download_url":"https://codeload.github.com/ladybug-tools/contributing/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ladybug-tools%2Fcontributing/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274231546,"owners_count":25245659,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-08T22:07:28.357Z","updated_at":"2025-09-08T22:07:34.130Z","avatar_url":"https://github.com/ladybug-tools.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"Contributing to Ladybug Tools Projects\n=========================================\n\nThank you for considering contributing to Ladybug Tools. We welcome contributions to all\nour [projects on Github](http://www.github.com/ladybug-tools) and from anyone, even if\nyou are new to open source we will be happy to help you to get started. Most of the\nLadybug Tools developers started learning programming through developing for Ladybug Tools.\n\nIssues\n------\nFeel free to submit issues and enhancement requests to each repository.\n\nContributing\n------------\nPlease refer to each project's contributing file for style guidelines. In general, we\nfollow the \"fork-and-pull\" Git workflow.\n\n 1. **Fork** the repo on GitHub\n 2. **Clone** the project to your own machine\n 3. **Commit** changes to your own branch\n 4. **Push** your work back up to your fork\n 5. Submit a **Pull request** so that we can review your changes\n\nIf you don't know what is Git read the section for [new users](#new-users).\n\nNOTES:\n 1. Be sure to open an issue or contact the current developers and let them know about your\n desire to work on the project. This will ensure that no one else is working on the same\n problem and also provides the opportunity for us to help you to get started with development.\n 2. Be sure to merge the latest from \"upstream\" before making a pull request!\n 3. An acceptable **Pull request** should not be more than 200 lines of changes otherwise\n it will be very hard for us to review the code.\n 4. Read the contributing.md of the project beforehand to ensure your pull request meets\n the requirement of the project.\n\nStyle guide\n-----------\nFor Python projects see Ladybug Tools [Python style guide](\nhttps://github.com/ladybug-tools/contributing/wiki/python-style-guide).\n \nPlease also take a look at the zen of Python by Tim Peters. To read the Zen of Python, please write \n```import this``` in your Python shell and run it.\n\nUnit conventions\n-----------\nAll Ladybug Tools repositories follow a convention of assuming SI units by default. Accordingly, all\nproperties on objects and all inputs to functions within a repository are expected to be in SI.\n\nFor developers needing to convert the inputs or outputs of Ladybug Tools repositories to other unit systems\nfor front-end interfaces, ladybug-core includes a [dataype module](https://github.com/ladybug-tools/ladybug/tree/master/ladybug/datatype) that is capable of converting between many types of units. \nFurthermore, all geometry objects of [ladybug-geometry](https://github.com/ladybug-tools/ladybug-geometry)\npossess `scale` methods that can be used to scale the geometry to/from meters.\n\nFor angular inputs and outputs, all Ladybug Tools repositories use degrees (as opposed to radians) with\nthe only excpetion being [ladybug-geometry](https://github.com/ladybug-tools/ladybug-geometry), which\nuses radians for faster trigonometric operations and better compatability with CAD interfaces.\n\nLicensing\n-----------------------\nMost of the Ladybug Tools repositories are open source under the GNU General Public License v3.0.\nunless indicated otherwise. For more information about the license see [here](https://github.com/ladybug-tools/honeybee/blob/master/LICENSE).\n\nNew Users\n---------\nThe first thing to do is to register a user name with [GitHub]( https://github.com/ ).\n\nYou will need to supply a username and email address and to create a password.\n\nAfter you have registered you can go to your [GitHub settings]( https://github.com/settings/profile ).\nHere you can add a photo and update your bio. It's a good thing to add at least some\ndata - especially a photo and a location. These help your friends remember and know\nthat it is really you.\n\nIf you are new and looking for some way to contribute a good place to start is to look\nat the issues tagged **good first issue**.\n\nSee [contributing notes for Spider project](http://www.ladybug.tools/spider/#pages/contributing.md)\nto learn how to become a team member and be a good citizen!\n\nFAQ\n---\nSee [here](http://www.ladybug.tools/about.html#faq) for FAQ.\nIf you can't find your question [open a new issue](https://github.com/ladybug-tools/contributing/issues/new).\n\nBe nice!\n--------\nPlease note that all participants of this project are expected to follow our\nCode of Conduct. We enjoy the development of Ladybug Tools and want to make it enjoyable\nfor others. We care about good code but value our community and the people over the code\nand development. By participating in Ladybug Tools project you agree to abide by its terms.\nSee [our code of conduct](CODE_OF_CONDUCT.md).\n\n\n### Thank you and happy coding! :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fcontributing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fladybug-tools%2Fcontributing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fladybug-tools%2Fcontributing/lists"}