open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership

Home Page:https://opensauced.pizza/learn

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

feat: Add a contributing guide

BekahHW opened this issue Β· comments

Type of feature

πŸ• Feature

Current behavior

There's no contributing guide.

Suggested solution

Since we've had some great contributions on this course and excitement around continued contributions, it's important to have a contributing guide specific to this repo. I'm thinking specifically about issue #43, we could have better supported our contributor by ensuring they knew more.

We link to the main contributing guide from the docs, but we should add specifics for this repo:

  1. how to add a new section, including conventions for numbering,
  2. the use of markdown,
  3. the need to add new sections to the sidebar.
  4. how to run the project locally. I suggest two methods: using the docsify CLI or using VS Code Go Live feature.
  5. how to add translations

So I would suggest adding a contributing.md with a link to https://docs.opensauced.pizza/contributing/introduction-to-contributing/ followed by the specifics

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Hi, @BekahHW. Can I work on this issue?

It's all you @Oguntunjiharlimatodunola!

Alright! Thank you @BekahHW .

Screenshot (1222)
@BekahHW , check the screenshot.
Am I on the track?

@CBID2 , this is the repo issue. I will mention you in the PR as well.