Add new recipe to the C-Cookbook #58

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
4 participants
Contributor

rongrw commented Jan 31, 2017

Updated the C-Cookbook (Cookbook.swim) by adding a new recipe titled "Direct Access to Perl variables". I've placed this recipe at the end of the section "Meat & Potatoes".

Also created a new file called "CONTRIBUTING".

Contributor

wbraswell commented Feb 1, 2017

@ingydotnet @sisyphus
This pull request affects documentation only, and the contents seems to have been well-thought-out.
I suggest merging.

Owner

ingydotnet commented Feb 1, 2017 edited

I don't understand. Why are you putting doc/Inline/C/Cookbook.pm into ./Cookbook.swim? The CONTRIBUTING file is a generated file for CPAN. It doesn't belong in the repo.

Please read and comprehend the About file and try again.

Contributor

wbraswell commented Feb 2, 2017

@ingydotnet
The content was put into a .swim file based on the recommendations of @mohawk2 and @daoswald here:
#56

The CONTRIBUTING file was also a recommendation by @daoswald ; while CONTRIBUTING may be automatically created by dzilla, this is not the case with the EU::MM projects I've worked on, and even GitHub's own docs talk about manually created this file:
https://help.github.com/articles/setting-guidelines-for-repository-contributors/#adding-a-contributing-file

We've all been trying our best to help @rongrw do the right thing, but since it does not meet with your approval, then it seems like you should provide some official guidance for @rongrw by clearly stating where do you want him to put the new content???

Contributor

rongrw commented Feb 2, 2017

Hi @ingydotnet , @wbraswell ,
Yes, I didn't place the Cookbook.swim into the correct directory. This was certainly not intentional and I do apologise for that. Unfortunately I'm still in the process of learning the github web interface.

I would like to see the new recipe make its way into the C-Cookbook because I find this doc to be such an excellent learning tool with really interesting examples. To that end, if I could be given some further advice to get the changes approved, I'll do that.

Thank you for guiding me thus far, and I do realise that you are all very busy.

Owner

ingydotnet commented Feb 2, 2017

@rongrw, your contribution looks fine, but why on earth would you copy
./doc/Inline/C/Cookbook.swim to ./Cookbook.swim?

I don't have a CONTRIBUTING file in any of my repos, and I'm not going to add
one here. There's a CONTRIBUTING file in the CPAN dist.

Please change doc/Inline/C/Cookbook.swim in place and get rid of the
CONTRIBUTING file.

Owner

ingydotnet commented Feb 2, 2017

I fixed/applied your PR myself. Thanks.

ingydotnet closed this Feb 2, 2017

Collaborator

perlpunk commented May 19, 2017

I'd vote for a CONTRIBUTING file in the repo too, because people are working with the repo and not the CPAN dist, when they want to contribute. Also, github has support for it.

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