Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.93 KB
Raw

Contributing to BuildingPy

First off, thank you for considering contributing to BuildingPy! It's people like you that make BuildingPy such a great tool for the building and construction community.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for BuildingPy. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use the GitHub bug report template: This template offers a structure for your bug report. Fill out as many fields as possible. The more details you provide, the easier it is for us to understand and fix the issue.
  • Check if the issue has already been reported: Use the search tool on the issues tab to see if your issue has already been reported. If it has, you can add a comment to the existing report instead of opening a new one.
  • Provide a clear and descriptive title.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for BuildingPy, including completely new features or improvements to existing functionalities.

  • Use the GitHub feature request template: Fill in the template with all the necessary details.
  • Provide a clear and descriptive title and a detailed explanation of the suggested enhancement.
  • Explain why this enhancement would be useful to most BuildingPy users.

Your First Code Contribution

Unsure where to begin contributing to BuildingPy? You can start by looking through the beginner and help-wanted tags in our issue tracker:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

  • Fill in the required template: All pull requests should include information about the changes, why they were necessary, and how they benefit BuildingPy.
  • Follow the style guides: Use the coding conventions and commit message formats established in BuildingPy.
  • Include tests: If you're adding new functionality, please also add tests to confirm it works as expected.
  • Document your changes: If you're changing the behavior of existing functionalities, updating the documentation is crucial.
  • Create feature branches: Don't ask us to pull from your main branch.
  • One pull request per feature: If you want to do more than one thing, send multiple pull requests.

Code Review

All submissions, including submissions by project members, require review. We use GitHub's pull request and code review features for this purpose.

Code of Conduct

Participation in the BuildingPy community is governed by our Code of Conduct. Please read and abide by it.

Recognition

We recognize all types of contributions. This project follows the all-contributors specification. Contributions of any kind welcome!