search

alecthomas / devtodo2

DevTodo the Second
100 stars 18 forks source link

Add CONTRIBUTING.md #12

Closed Zearin closed 10 years ago

Zearin commented 10 years ago

For anyone who is about to create a new Issue or make a Pull Request, GitHub will auto-link a CONTRIBUTING.md file if it exists in the top-level of a repo, right above the form.

(Of course, the real reason I’m creating this issue is that I want to contribute…but I have no idea how. ☺)

alecthomas commented 10 years ago

I'm not sure what you want to know? It's a standard Go binary, so normal procedures apply.

Zearin commented 10 years ago

I'm not sure what you want to know? It's a standard Go binary, so normal procedures apply.

Well, basically, I want to help…but I am unfamiliar with Go. :)

alecthomas commented 10 years ago

While I'd definitely welcome contributions, I don't think it's practical for every project to document standard development practice for the languages it uses. It would be akin to describing how to use Maven if it were a Java project.

If you're interested, though, I suggest starting here. The documentation is quite comprehensive.

Zearin commented 10 years ago

While I'd definitely welcome contributions, I don't think it's practical for every project to document standard development practice for the languages it uses. It would be akin to describing how to use Maven if it were a Java project.

Oh, I agree! In hindsight, this wasn’t a well-thought-out Issue on my part.

Let me revise my original request to a few specific questions:

  1. In the Makefile, I see targets for install and clean. Are there any targets for developing this project?
  2. If I read the Makefile right (I have a rudimentary understanding, but that’s all), it looks like clean is being used like “uninstall”; i.e. it removes the “normal installation”, rather than a build directory (or whatever). Is that correct?
  3. Would these things be worthy of a CONTRIBUTING.md file? ☺
alecthomas commented 10 years ago

If you type make it will build the binary and man page in the current directory. You can then run it with ./todo2. make clean will remove both files from the current directory.