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

Update CONTRIBUTING.MD #2

Open
13 tasks
mwlee29 opened this issue Oct 1, 2022 · 1 comment
Open
13 tasks

Update CONTRIBUTING.MD #2

mwlee29 opened this issue Oct 1, 2022 · 1 comment
Labels
enhancement New feature or request suggestion Suggested improvement to the repo

Comments

@mwlee29
Copy link
Contributor

mwlee29 commented Oct 1, 2022

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."

@mwlee29 mwlee29 added enhancement New feature or request help wanted Extra attention is needed labels Oct 1, 2022
@mwlee29
Copy link
Contributor Author

mwlee29 commented Oct 1, 2022

Suggestion for requirements - users should have their Slack handle in the PR so that we can verify their affiliation prior to merging.

@mwlee29 mwlee29 added suggestion Suggested improvement to the repo and removed help wanted Extra attention is needed labels Oct 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request suggestion Suggested improvement to the repo
Projects
None yet
Development

No branches or pull requests

1 participant