[GitHub] couchdb-documentation issue #111: Requesting a CONTRIBUTING.md document

[flimzy <gi...@git.apache.org>]

GitHub user flimzy opened an issue:

    https://github.com/apache/couchdb-documentation/issues/111

    Requesting a CONTRIBUTING.md document

    As I'm finding myself contributing more and more PRs to this documentation, I wish I had some guidelines, other than the existing docs, for what's acceptable.
    
    - How detailed should descriptions be?
    - Are config options expected to always show default values? Or is any valid value permitted?
    - Is it appropriate to retroactively update `whatsnew` documentation?
    - (Where) should documentation changes be discussed before submitting a PR?
    
    And I'm sure many more questions will come up.
    
    Are these things documented somewhere? I'd be happy to turn them into a CONTRIBUTING.md document and submitting a PR. :)

----

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] couchdb-documentation issue #111: Requesting a CONTRIBUTING.md document

[wohali <gi...@git.apache.org>]

Github user wohali commented on the issue:

    https://github.com/apache/couchdb-documentation/issues/111
  
    I recommend you join the dev@couchdb.apache.org mailing list and post this question there, where it might get a bit more attention. (GH issues are brand new to CouchDB and aren't being watched carefully yet.) And it's probably the answer to your last question as well. :)
    
    I'd love to review and help you merge a CONTRIBUTING.md once you've got the answers you need.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---