Skip to content
This repository was archived by the owner on Apr 12, 2018. It is now read-only.

Include a CONTRIBUTING.md file #328

Closed
fireproofsocks opened this issue Oct 20, 2015 · 4 comments
Closed

Include a CONTRIBUTING.md file #328

fireproofsocks opened this issue Oct 20, 2015 · 4 comments

Comments

@fireproofsocks
Copy link

Contributing is more difficult than it needs to be. It would be helpful to include a CONTRIBUTING.md file to outline what is required to contribute changes to the docs.

  1. It would also be helpful to give contributors a lay of the land to explain which files should be edited. Are we supposed to update files in the src directory? XML is not what users are probably expecting.
  2. Also, you should clarify here which folder to use when submitting edits. If version 5.2/xx/ does not contain the file I wish to update, does the build process fall back to the latest version it can find? I assume that's the case, but assumptions should be clarified.
  3. Should we fork the repo? Is there a branching structure or tagging convention you follow?
@nelson6e65
Copy link

👍

@sebastianbergmann
Copy link
Owner

Instead of the documenting the way it currently works I'd rather change the way it currently works to make it easier to contribute

  • Replace DocBook/XML and XSLT with Markdown
  • Only have one edition of the documentation instead of one per version
  • ...

@fireproofsocks
Copy link
Author

See #329

@sebastianbergmann
Copy link
Owner

Closing because of the reasons given in #328 (comment). The new process etc. is covered in #471.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants