Swag-for-dev: Document the current architecture

Created on 12 Dec 2018  ·  12Comments  ·  Source: swapagarwal/swag-for-dev


Issuehunt badges

A newbie needs to learn a bit of gulp, pug, styl. The doc can cover all things end-to-end from data.json to Netlify deployment.
This is important for onboarding new core contributors.




IssueHunt Summary

Backers (Total: $20.00)

- #398 Document the current architecture

Become a backer now!

Or submit a pull request to get the deposits!

Tips

IssueHunt has been backed by the following sponsors. Become a sponsor


good first issue help wanted 🏃‍♂️ in progress

Most helpful comment

If you want to assign me to this one that would be awesome! I've gotten started describing some of the files that I've looked through in a DOCUMENTATION.md file!

All 12 comments

@swapagarwal has funded $20.00 to this issue. See it on IssueHunt

@aslafy-z You seem to be the best person to do this!

Hi there, looking to get my first open source contribution under my belt. Could you explain a bit more about what you're looking for?

Daneel

Hi Daneel

We are looking for a document that explains how the website is built so that new folks can contribute in a scalable way.
If your English is good and you know a little bit of gulp, pug, styl, netlify (don't worry; folks are here to help you out!), let us know. 😇

Well my English is good, but I don't know any of those :( well, I'll keep looking!

It's even better if you don't know these things. 😂
Your documentation would be targeted towards new contributors, so I think you'd do an amazing job of connecting with the audience.
The only thing required is that you would need to put in the effort (might be a couple of days, might be a few weeks) to understand the concepts and write a README that you wished it already existed.

Well, I suppose I could give it a shot!!

If you want to assign me to this one that would be awesome! I've gotten started describing some of the files that I've looked through in a DOCUMENTATION.md file!

Hi, is anyone onto this or could I have a go?
@daneelrakow @swapagarwal

@co16353sidak Afaik No one else is on this currently.

Hi do take a look at the Pull Request and let me know what else you'd like to add.

hi is this still open?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

chiragw15 picture chiragw15  ·  4Comments

jgierer12 picture jgierer12  ·  3Comments

swapagarwal picture swapagarwal  ·  4Comments

kevin51jiang picture kevin51jiang  ·  6Comments

swapagarwal picture swapagarwal  ·  4Comments