Skip to content

Add CONTRIBUTING.md #6

Closed
Closed

Description

@SleeplessByte

Currently there is no CONTRIBUTING.md present in the root of this repository. Add a CONTRIBUTING.md with at least the following:

How to general

  • how to contribute
  • what is expected in issues
  • what is expected in pull requests
  • what steps to take in order to submit a PR

How to specific

  • add a new analyzer (for an exercise)
  • update an analyzer (sync)
  • add new behaviour to an existing analyzer
  • change the copy that is generated

Have a look at problem-specifications/CONTRIBUTING.md.

Activity

  1. zeckdude commented on May 31, 2019

    @zeckdude
    Contributor

    I could help with this, but I don't know the answers to some of these areas. Can you help me fill in the blanks and I'll write it up?

    How to general

    • how to contribute: I'm assuming it's as easy as reaching out on the slack group and then just looking at the issues, claiming an issue and then forking the repo and once the work is done, create a PR? Am I missing something? Btw, do we want to create a javascript-analyzer slack group?
    • what is expected in issues: I don't know the answer to this. Need clarification.
    • what is expected in pull requests: I don't know the answer to this. Need clarification.
    • what steps to take in order to submit a PR: I'm assuming it's just forking the repo and once the work is done, create a PR? I would ofcourse write out the exact steps, but that's the basic idea, right?

    How to specific

    • add a new analyzer (for an exercise): Can we add new analyzer's even if there is no issue for it? I assume this just involves dissecting one of the existing analyzers and then writing the logic to fit for the exercise you want to auto mentor?
    • update an analyzer (sync): What do you mean by sync? I don't know the answer to this. Need clarification.
    • add new behaviour to an existing analyzer: I don't know the answer to this. Need clarification.
    • change the copy that is generated: Is there is a standard operating procedure for this? I would assume it would be tp just create a PR for fix the copy. Am I missing something?
  2. SleeplessByte commented on Jun 8, 2019

    @SleeplessByte
    MemberAuthor

    @zeckdude have a look at c34f480 which is the first iteration of the document. This should answer most of your questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions