Skip to content

Seeking editorial and review guidelines in the README/CONTRIBUTING md #5476

@ross-spencer

Description

@ross-spencer

Having recently seen one of my own PRs for a new guide rejected and another I was following rejected, is there something that can be added to the contributing guidelines that describes what the site is currently looking for?

There are currently:

  • languages
  • frameworks
  • algorithms
  • tools

The README still says, all contributions are welcome: https://github.com/adambard/learnxinyminutes-docs?tab=readme-ov-file#contributing

But even if the contributing page says accepted contributions are up to the BDFL it still helps those who want to build the resource if there is a clear framework to work within. It is only a style guide right now: https://github.com/adambard/learnxinyminutes-docs/blob/master/CONTRIBUTING.md but if reviews don't refer back to any particular point of concern/issue or offer anything constructive feedback wise, it's not really fostering community.

Additionally, as such a respected site and publishing mechanism, maybe there could be some guidance about what to do with a rejection, e.g. fork the repo, host it yourself? Host the single page build yourself? Or maybe there's room to discuss forks of this repo for the underutilized sections, tools/algorithms/frameworks...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions