Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 1.94 KB

Contributing

All of our contributions flow through GitHub.

Write an article

Interested in writing an article for Perl.com? Perhaps you want to get the word out about your new startup, provide a tutorial on your favorite module, or have community news to share. This document is for you.

You can propose an article as a GitHub issue, or simply send up a pull request. Inside the repo, you can run the make new target and you'll be led through the questions to set up your initial article template:

% cpm install -g --cpanfile cpanfile
% make new

You can then check your article by starting a local server using Hugo . Note that v0.59 of Hugo was previously recommended, however the repo here is confirmed to be working with versions as recent as v0.126 and deployment is using a pinned version. You may want to confirm your updates with v0.59 to be sure.

To start the server run:

% make start

Once you submit your article, an editor will help guide it to its final form.

Don't know what to write about? See our article on how to find a topic.

Check out our first time author tutorial to understand our contributor process. Our Style Guide describes our standards and has tips to make your articles better. For the most part, your article should look and read like other Perl.com articles.

Fix a problem

Since we've moved to GitHub, it's easy for you to fix problems you find, whether that's a simple typo to adjusting code for new interfaces.

You can edit files directly in GitHub, which will automatically fork our repo and send a pull request.

For big edits, you might want to raise a GitHub issue before you spend too much time on it.

© Perl.com