couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From flimzy <...@git.apache.org>
Subject [GitHub] couchdb-documentation issue #111: Requesting a CONTRIBUTING.md document
Date Wed, 15 Mar 2017 09:30:36 GMT
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.
---

Mime
View raw message