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

Contributing instructions #904

Closed
bfirsh opened this Issue Dec 14, 2017 · 7 comments

Comments

Projects
None yet
4 participants
@bfirsh
Contributor

bfirsh commented Dec 14, 2017

There don't seem to be any instructions for simple things like:

  • How to get a development environment set up (seems to be similar to installing, but it's not clear whether installed latexml is the same one I'm working on in source directory)
  • Running the tests
  • Writing a test (and how to run a single test to iterate on it)
  • Writing a new binding with a test (presumably the most common contribution you want)

I'm currently doing all of these things, so happy to write down what I am doing! Should I create a new section in the manual, or would you like them somewhere else? CONTRIBUTING.md in the root directory is a pretty common pattern.

@dginev

This comment has been minimized.

Collaborator

dginev commented Dec 19, 2017

We should make the wiki less hidden as a first step, I think @brucemiller came to like that space most - https://github.com/brucemiller/LaTeXML/wiki

We had a very impressive back-and-forth some time ago whether we should use .md files as is the github standard, and as you can see we have settled with the more alien .pod format, which is the Perl best practice here.

You could add the steps you go through as comments in this issue and we move them to the wiki, or just give you wiki permissions right away, or ... Will let Bruce decide.

And we should definitely make whichever way we go clear from the readme. Thanks for the issue!

@dginev dginev added this to the LaTeXML-0.8.4 milestone Dec 19, 2017

@brucemiller

This comment has been minimized.

Owner

brucemiller commented Dec 21, 2017

Wiki? Oh, yeah... we should make it less hidden! :> Is there a way for the pod/md to be on top, or even omit the "code" from the initial page? That would make more of the project info visible. And, yes, we should make the existence of the wiki more visible. In fact, should invite users to contribute their advice. If I'm not mistaken, it already is writable by any github user.

@brucemiller

This comment has been minimized.

Owner

brucemiller commented Dec 21, 2017

Hmm, interesting: somebody just made a mod to the wiki, noting that the kwarc links to arXMLiv don't work any more! Doesn't seem that I receive notifications when somebody modifies the wiki, but I think I'd like to.

@dginev

This comment has been minimized.

Collaborator

dginev commented Dec 21, 2017

@brucemiller you should star+watch this repository, then you see the notifications - I got one 👍 I also know those links are dead with a high likelihood of them not coming back, so those pages may need to be rewritten and updated... Looking at a mirror.

@skellat

This comment has been minimized.

skellat commented Dec 23, 2017

I’ll freely admit I made the change. I’m still on furlough from Treasury so I want to be constructive.

@brucemiller

This comment has been minimized.

Owner

brucemiller commented Dec 23, 2017

@skellat; you did the right thing! I was only surprised that I didn't get a notification from github. I obviously watch this repo, but didn't star it; maybe that makes a difference? We'll see.

@brucemiller

This comment has been minimized.

Owner

brucemiller commented Feb 17, 2018

I've just done some reorganizing and fleshing out of the wiki pages. There's now a how to contribute (not sure how to link from here!) It's a start at what you were asking for. Take a look and feel free to improve it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment