Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 6.46 KB

CONTRIBUTING.md

File metadata and controls

93 lines (63 loc) · 6.46 KB
Raw

Community Articles: Contribution Guide 👩🏻‍💻👨🏾‍💻👩🏼‍💻

Welcome to the Codecademy Community Articles GitHub repo!

We are an inclusive and passionate team of technologists and life-long learners around the world building free programming resources for a better tomorrow. All the content in UGC articles are written by amazing creative developers like yourself.

If you have some interesting learnings to share with the community, we'd love to have you contribute. 💖

How do I contribute?

There are many ways to contribute to UGC articles:

  • Submit a Pull Request to edit an existing article (typo/bug).
  • Submit a Pull Request to create a new article of your choice.
  • Take a look in GitHub Issues to get inspirations for your article.
  • Join the #CodecademyUGC discussion on Twitter.

If you're new to UGC articles and contributing for the first time, it is recommended that you visit the Issues section and ask to be assigned to an open issue that interests you. Otherwise, feel free to submit a PR by creating a new branch in your fork to create a new article or edit an existing one.

What do I need to do before creating a new article?

Before creating your first article, poke around the /content folder. This is where all the content is stored.

.
├── ...
├── content                  # Content files
│   ├── author
|   |   ├── author_meta.json 
|   |   ├── article1.md      
|   |   ├── article2.md
│   └── ...
├── documentation            # Documentation files
└── ...

And here, templates for creating your new articles:

Template GitHub Example Article Example
Article Template web-scrape-with-selenium-and-beautiful-soup.md (Raw) Web Scrape with Selenium and Beautiful Soup
Author Template author_meta.json N/A

Please read through the following in the /documentation folder. In these links, you'll find a write-up of our standards for content and style:

Codecademy Username and Profile Pic

As a UGC article content creator, you have the opportunity to have your Codecademy username and avatar displayed on the article!

How do I submit a Pull Request (PR)?

Contributing follows this workflow:

  1. Fork this project repository.
  2. Clone the forked repository to your computer.
  3. Create and switch into a new branch.
  4. Edit or create an article and commit the changes.
  5. Make a PR to merge your fork with this repo.

If you haven't gone through this workflow before, you can check out this GitHub tutorial (highly recommend) or this YouTube video to learn about how to make a PR from a fork using Git.

Alternatively, if you'd prefer to keep things to the GitHub UI, you can follow the instructions in that video up to 1:18 to fork this repo. After that, you can create your article in your fork using the UI and then make a PR by pressing this handy button:

Code block with Codebyte tags

If you are uncomfortable using Git, you can also check out this YouTube video to do this all using the GitHub Desktop app.

Any tips for a Pull Request?

  • Before making a PR, make sure you pushed your changes from a branch other than main.
  • Name the new branch after the changes being pushed to the PR.
  • Keep your PRs byte-sized. 1 article per PR!
  • All contributors must sign the Contributor License Agreement (CLA).
  • All required status checks are expected to pass in each PR.
  • For Beta, we currently require at least one round of reviews from the content team members. Make sure to make the changes within 5 days.
  • Requested changes must be resolved before merging.
  • Your article will be deployed within the hour after it's merged!

What do we check for?

  • Technical accuracy
  • Formatting standards
  • Typos/bugs
  • Plagiarism

Additional Resources

Remember, if you ever have any questions at all, we're always here to help in the Codecademy Forums and Codecademy Discord.