search

datacarpentry / r-raster-vector-geospatial

Introduction to Geospatial Raster and Vector Data with R
https://datacarpentry.org/r-raster-vector-geospatial
Other
113 stars 110 forks source link

Update CONTRIBUTING.md to give the same instructions as are in README.md #411

Closed bechandcock closed 1 year ago

bechandcock commented 1 year ago

The repository currently has conflicting instructions for which branch to clone for updating, and should be updated. CONTRIBUTING.md says to work from ‘gh-pages’ but README.md says to work from ‘main’.

This is particularly confusing for new editors as the Instructor check-out instructions say to follow the instructions in the CONTRIBUTING.md.

Current wording of CONTRIBUTING.md "The published copy of the lesson is in the gh-pages branch of the repository (so that GitHub will regenerate it automatically). Please create all branches from that, and merge the master repository's gh-pages branch into your gh-pages branch before starting work. Please do not work directly in your gh-pages branch, since that will make it difficult for you to work on other contributions."

Current wording of README.md The lesson files to be edited are in the _episodes folder. This repository uses the main branch for development.

albhasan commented 1 year ago

Hi Bec,

You're right. The CONTRIBUTING page is outdated and out of sync with the CONTRIBUTING pages in other lessons.

I don't know if this is something we fix using a pull request of if this is something the Capentries takes care of automatically.

Bests,

zkamvar commented 1 year ago

Hi @albhasan, The CONTRIBUTING file is one of the things that we provide the template for, but because it contains repo-specific details, it needs to live inside the repository. During the transition, there were some repositories that did not get an updated version of the template, so this indeed needs to be fixed on the maintainer end (as in #413)