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

📝 Contributors guide #12

Merged
merged 6 commits into from
Jul 15, 2024
Merged

📝 Contributors guide #12

merged 6 commits into from
Jul 15, 2024

Conversation

znatty22
Copy link
Member

@znatty22 znatty22 commented Jul 8, 2024

Motivation

Multiple people are going to start contributing to this repository but we don't have guidelines on the software development lifecycle for people to follow.

Approach

Create a contributors guide via a markdown doc that new developers can follow to understand the basic Github workflow of authoring commits, reviewing code, and making releases.

Closes #10

@znatty22 znatty22 added the documentation Improvements or additions to documentation label Jul 8, 2024
@znatty22 znatty22 self-assigned this Jul 8, 2024
@znatty22 znatty22 marked this pull request as draft July 8, 2024 19:52
@znatty22 znatty22 force-pushed the contributors-guide branch 2 times, most recently from 721ba12 to 6f6835b Compare July 9, 2024 14:00
@znatty22 znatty22 marked this pull request as ready for review July 9, 2024 14:13
README.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pull request July 9, 2024 16:41 Inactive
Copy link

github-actions bot commented Jul 9, 2024

🚀 IG Site Preview Deployed

Latest commit: 4909aad

View deployment

aw3334
aw3334 previously approved these changes Jul 9, 2024
.github/contributing.md Outdated Show resolved Hide resolved
.github/contributing.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pull request July 11, 2024 14:12 Inactive
@znatty22 znatty22 requested review from wnkhan and aw3334 July 11, 2024 14:17
@github-actions github-actions bot temporarily deployed to pull request July 11, 2024 14:19 Inactive
torstees
torstees previously approved these changes Jul 11, 2024
Copy link
Collaborator

@torstees torstees left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks good to me!

.github/contributing.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pull request July 15, 2024 14:12 Inactive
@github-actions github-actions bot temporarily deployed to pull request July 15, 2024 14:13 Inactive
@znatty22 znatty22 merged commit 848dfe8 into main Jul 15, 2024
3 checks passed
@znatty22 znatty22 deleted the contributors-guide branch July 15, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement Software Development Lifecycle
4 participants