Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve contributing.md #1

Open
hhkaos opened this issue Jun 4, 2021 · 1 comment
Open

Improve contributing.md #1

hhkaos opened this issue Jun 4, 2021 · 1 comment
Labels
help wanted Extra attention is needed type: discussion type: documentation Improvements or additions to documentation type: enhancement New feature or request

Comments

@hhkaos
Copy link
Member

hhkaos commented Jun 4, 2021

I'm bringing too many topics on this issue, and maybe some can be discussed in the future when PR start coming, but I wanted us to be aware that contributing guides can be tricky ^_^.

I would try to keep it short but at the same time define the most important rules like:

  • Use the following format: [Item Name](link) - A short description ends with a period (Keep descriptions concise)
  • Do we only add resources with free access or free tiers?
  • Link additions should be added in alphabetical order of the relevant category.
  • What's allowed and what's not, for example:
    • Do we allow a resource in multiple categories?

    • Do we allow beta/alpha projects?

    • I guess we allow multiple links to the same domain, right?:

      • developers.arcgis.com/documentation, developers.arcgis.com/arcgis-rest-js/....
      • but also: blog articles, training courses, ... <- or if there is a way to list and filter resources (like developer blog, Scripting & Development courses) we just point to it?
    • I guess new categories or improvements to the existing categorization are welcome.

    • Do we allow any resource that can be useful for a developer, no matter who made it?, let me raise a controversial one 😉 -> QGIS could be a source?, PostGIS?, Turf?, ... (I personally think... we should)

    • How many Category levels do we allow? 1, 2, ...?

    • Do we allow more than one link per line? for example:

  • What do we do with localized resources?, imagine there are things that make sense to highlight but only in Spain, or only in the US? (like awesome datasets?) do we create a folder local awesomes?
  • I guess we don't want to add too many resources per each specific ArcGIS API or Service, right?
  • Make an individual pull request for each suggestion.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
    The pull request and commit should have a useful title.

Other contributing.md: awesome-eslint, awesome-geojson, awesome-awesome

@hhkaos
Copy link
Member Author

hhkaos commented Jun 7, 2021

sorry @jf990 I forgot to mention you here 😉

@hhkaos hhkaos added the type: enhancement New feature or request label Jan 18, 2023
@hhkaos hhkaos added help wanted Extra attention is needed type: discussion type: documentation Improvements or additions to documentation labels Sep 12, 2023
hhkaos pushed a commit that referenced this issue Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed type: discussion type: documentation Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant