OSMBuilding icon indicating copy to clipboard operation
OSMBuilding copied to clipboard
verified publisher icon Beakerboy

Create CONTRIBUTING.md

Open Beakerboy opened this issue 1 year ago • 4 comments

#57

Please comment on this first draft.

https://github.com/Beakerboy/OSMBuilding/blob/Coverage/CONTRIBUTING.md

Beakerboy avatar Jun 20 '24 12:06 Beakerboy

@Venefilyn

Beakerboy avatar Jun 20 '24 20:06 Beakerboy

@Beakerboy I think we could do it more generic. Ideally CONTRIBUTING.md to me is more about how to setup a development environment or how to report a bug (but that can also be in README.md

But something like, how to install dependencies, how to run tests, how to develop locally.

Some examples here

  • https://github.com/openstreetmap/iD/blob/develop/CONTRIBUTING.md
  • https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/CONTRIBUTING.md
  • https://github.com/packit/packit-service/blob/main/CONTRIBUTING.md

Venefilyn avatar Jun 20 '24 20:06 Venefilyn

I’ll check that out. To be honest, my development platform is to go to GitHub.io, open a building, and edit the javascript files in the Edge browser development tools. When it does what I want I copy and paste the changes into GitHub.

The other way is to to use classic test-driven development. Write a test and push to a branch on GitHub. If it fails, either edit the test or source (or both) until it passes, then squash-merge, all using GitHub as my IDE.

Beakerboy avatar Jun 20 '24 22:06 Beakerboy

I already use GitHub workflows to run the Linting checks, run tests, and measure coverage. That means my npm dev-dependencies are all set correctly. I guess I could just say to use npm with the provided package settings to set up the development system, no?

Beakerboy avatar Jun 20 '24 22:06 Beakerboy