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

[Docs] Update ways to contribute to LoopBack #1228

Closed
virkt25 opened this issue Apr 3, 2018 · 4 comments
Closed

[Docs] Update ways to contribute to LoopBack #1228

virkt25 opened this issue Apr 3, 2018 · 4 comments
Labels
Contributing Things making it easier and more pleasant to contribute to LoopBack Docs

Comments

@virkt25
Copy link
Contributor

virkt25 commented Apr 3, 2018

Description / Steps to reproduce / Feature proposal

This issue came about based on the March Retrospective

Currently the Contribution Guidelines indicate that a way to contribute to the project includes the following:

  • Reporting issues
  • Contribution to code
  • Contribution to docs

We need to add a new section to tell users that another way they can contribute to LoopBack (Next and 3.0) is by helping us Triage issues! This section should include details on what triaging means -- ensuring a repro sandbox is available / works, answer doesn't exist in Docs, identifying the issue as a question, bug or feature request, etc.

To be consistent and depending on the amount of content that needs to go under this section it might make sense to add a new page to the Sidebar as all other approaches have a dedicated page. However I think that should only be done if there is enough content for guidelines on how to triage an issue.

@dhmlau
Copy link
Member

dhmlau commented Apr 5, 2018

Thinking out loud here...
Ways to contribute:

Inspired by:

Also, we have duplicate information in various places that might need to clean up:

My suggestion is to have a single place of content. If we need to have it in multiple places (for example we still want to keep CONTRIBUTING.md), we can make it to reference the main location.

@dhmlau dhmlau added the non-DP3 label Apr 20, 2018
@dhmlau dhmlau removed the non-DP3 label Aug 23, 2018
@bajtos bajtos added Docs TOB Contributing Things making it easier and more pleasant to contribute to LoopBack labels Oct 15, 2018
@bajtos
Copy link
Member

bajtos commented Oct 18, 2018

While we are making this changes, it would be great to upgrade our ISSUE TEMPLATE to support multiple kinds of issues. See what TypeScript has for an example:

https://github.com/Microsoft/TypeScript/issues/new/choose

screen shot 2018-10-18 at 16 34 43

@dhmlau
Copy link
Member

dhmlau commented Dec 2, 2018

It seems to be a collection of the following issues:

@dhmlau dhmlau removed this from the December 2018 Milestone milestone Dec 2, 2018
@dhmlau
Copy link
Member

dhmlau commented Dec 19, 2018

Seems like the changes for all the 3 sections are done. Closing it as resolved.

  • Reporting issues
  • Contribution to code
  • Contribution to docs

@dhmlau dhmlau closed this as completed Dec 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contributing Things making it easier and more pleasant to contribute to LoopBack Docs
Projects
None yet
Development

No branches or pull requests

4 participants