Skip to content

Update CONTRIBUTING.MD #2

Open
Open
@mwlee29

Description

@mwlee29

Since this repo is intended to function as both a source of information and a platform for code newbies to learn how to work on collaborative projects, we need contributing guidelines that meet the following requirements:

  • Introduction congratulating/thanking the reader on their interest in contributing and explaining some of the benefits of contributing.
  • Adheres to Techlahoma's Code of Conduct
  • Explains the various ways that somebody could contribute to the repo:
    • Adding links Slack posts/threads that contain useful or interesting discussions, information, or insights
    • Adding experiences
    • Fixing typos, outdated information, broken links, etc. (bugs)
    • Suggest improvements
  • A list of contacts for questions about the contribution guidelines
  • Provides information about the actual process of contributing (git, branching/merging, creating a PR, etc.).
    • Preferably this would be a step-by-step tutorial on how to do this. For now we can link to other resources
  • Requirements for a PR to be approved
    • Should be very simple requirements - the intention is to prevent spamming from users that aren't affiliated with Techlahoma.

It is important to remember that the purpose of this repo is to be newbie-friendly. Try to do the following:

  • Avoid writing in a way that suggests hard requirements (excluding information that pertains to Techlahoma's Code of Conduct).
  • Try to present information in small, digestible chunks.
  • Keep it light. Any information in this document is merely a suggestion (excluding the requirement to adhere to Techlahoma's Code of Conduct)

Feel free to put your own spin on this! There are no hard requirements on what this document should look like. The goal is to have newbies look at it and think "okay, I can definitely do this."

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestsuggestionSuggested improvement to the repo

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions