Skip to content

Commit

Permalink
Merge pull request #12 from UpstateWomenInSoftwareEngineering/JenBaue…
Browse files Browse the repository at this point in the history
…r-readme

Update README.md with project processes
  • Loading branch information
JenBauer authored Oct 16, 2024
2 parents 683b395 + 21476e9 commit 47564d2
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,30 @@ Given the time the user has to study (5 min to 2 hours), the tools they have ava

More to come on the use cases for this tool!

*This is a 🎃#Hacktoberfest2024 project and collaborators are welcome*
This project is part of 🎃#Hacktoberfest2024, supported by UpWiSE. All are welcome to work on issues and join in!

### How to Help This Project
1. Before beginning any work, please review the Issues for this repository to see what work is available. The following filter shows which issues do not have an Assignee, and can be assigned: [Unassigned Issue Filter for the Course Tracker](https://github.com/UpstateWomenInSoftwareEngineering/study_helper/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee)
2. When you find an issue you'd like to take on, leave a comment to request that you be assigned to the issue.
3. Once a project admin assigns the issue to you, you can begin the issue work! ✨
4. Clone the repository locally, then create a Branch to begin working on the issue.
5. Begin working on the branch in your local space. When the work is complete, Commit your changes to the branch. Then, create a Pull request to submit your changes.
6. In the Pull request, be sure to include a clear description with what your changes includes and a statement with “Closes #” referencing the issue that should close related to the pull request.
7. An UpWiSE team member will review your Pull Request.
- If the request is good without changes, it will be Approved.
- If changes are needed, will we write to you with a comment about what to change.
8. Hacktoberfest Details: After the PR is approved, the reviewer will add the "hacktoberfest-accepted" label. Then, the Hacktoberfest project itself will need time to account for the activity. When it does, you will be able to see the accepted PR in your Hacktoberfest.com account.
- Additional details about Hacktoberfest 2024 are in [our UpWiSE Notion space here](https://pinnate-goldenrod-da6.notion.site/Hacktoberfest-2024-1180faf7365880f78958dee6b52c7937?pvs=4).

### Technical Stack
*TBD, awaiting initial project check-in*

### Initial Setup Instructions
*TBD, awaiting initial project check-in*

## Project Notes
### User Stories
TBD

### Wireframes
TBD

0 comments on commit 47564d2

Please sign in to comment.