Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve contribution guidance #3636

Closed
tiffy74 opened this issue Aug 26, 2018 · 4 comments
Closed

Improve contribution guidance #3636

tiffy74 opened this issue Aug 26, 2018 · 4 comments

Comments

@tiffy74
Copy link
Contributor

tiffy74 commented Aug 26, 2018

What type of issue is it? (Choose one - delete the others)

Missing documentation

What article/section is this about?

https://github.com/umbraco/Umbraco-CMS/blob/dev-v7/docs/CONTRIBUTING_DETAILED.md

Describe the issue:

The contribution guide is great and very well written however to make it easier to understand as a reference please separate out the section on What should I know before I get started?. Most users / devs who have not worked with Umbraco before will want to begin with this section so it makes little sense in placing it halfway down a page within a section on contributing in detail.

@sofietoft
Copy link
Contributor

Hi @tiffy74

You have a good point here!
I've forwarded it to @nul800sebastiaan , and he'll add it to his list to look into.

I can see you've already been busy making PRs - like umbraco/UmbracoDocs#969
If you're interested, you are very welcome to make one for this issue as well 😁

-Sofie

@tiffy74
Copy link
Contributor Author

tiffy74 commented Aug 30, 2018

Thanks @sofietoft

Would be more than happy to look into this further and see what I can do.

If there's anything that yourself or @nul800sebastiaan think I should be aware of before I get stuck in - then feel free to let me know. Always happy to work on this with others :)

@tiffy74
Copy link
Contributor Author

tiffy74 commented Sep 18, 2018

Just an update - am working on this documentation and re-structuring it in order to make it more readable to the lay person. Will update further when I have something to show :)

@nul800sebastiaan nul800sebastiaan transferred this issue from umbraco/UmbracoDocs Nov 15, 2018
@nul800sebastiaan
Copy link
Member

Hey @tiffy74 - it's been a while on this one! We'd still love any help if you think it's necessary, but feel free to just submit a PR for that, we don't need an issue to track this. I'll close this one for now! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants