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

Create CONTRIBUTING.md guidelines file #17

Open
mihok opened this issue Apr 22, 2017 · 1 comment
Open

Create CONTRIBUTING.md guidelines file #17

mihok opened this issue Apr 22, 2017 · 1 comment
Assignees

Comments

@mihok
Copy link
Member

mihok commented Apr 22, 2017

As we try to promote more community members helping with the site, I think it makes sense we should include a CONTRIBUTING.md file.

My thoughts are even though some of these things should be fairly obvious if you have worked in OSS before, we should be explicit. This is a chance for us to be a "guiding light" for newcomers to learn about open source development and get involved.

  • We should highlight the development process. (fork > branch your local repo > code/commit/push local repo > create PR with torontojs repo, etc)
  • Create issues (if they dont already exist) for discussion on reasonably large implementation and/or changes
  • We should speak about assigning recommended reviewers (probably @alex-wilmer and @tazsingh or one of the organizers?)
  • Link to the tojs-styleguide (and update it if necessary)
  • Explain anything unique in the design/architecture

Lets discuss anything here that we're not aligned on or that I'm missing

I'm happy to build out the document if @alex-wilmer is available to probe for any questions regarding design/architecture

(cc: @dxnn @pauldowman)

@alex-wilmer alex-wilmer self-assigned this Apr 22, 2017
alex-wilmer added a commit that referenced this issue Apr 23, 2017
 #17

Signed-off-by: Alex Wilmer <djazium@gmail.com>
@dxnn
Copy link
Member

dxnn commented Apr 30, 2017

This is a fantastic idea! Happy to help review PRs etc when I can.

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

Successfully merging a pull request may close this issue.

3 participants