Skip to content

Commit 747e2d2

Browse files
committed
added good first issue template,tastcard template and updated the contributing.md template with new cantact information
1 parent dee434c commit 747e2d2

5 files changed

Lines changed: 160 additions & 226 deletions

File tree

Lines changed: 81 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,81 @@
1-
# Contributing to Digital Bones Box
2-
3-
Thank you for checking out **Digital Bones Box**! We are so happy you are here. If you are intrested in contributing to the project below are some guidelines that help us make most out of your contribution.
4-
5-
## Getting Started
6-
7-
### How to Contribute
8-
9-
### 1. **Fork the Repository**
10-
- Navigate to the Digital Bones Box repository on GitHub
11-
- Click the "Fork" button on the top right of the repository page to create your own copy.
12-
13-
14-
### 2. **Clone Your Fork**
15-
- Clone the repository to your local machine:
16-
```bash
17-
git clone https://github.com/oss-slu/DigitalBonesBox
18-
cd your-repo
19-
20-
21-
### 3. Create a New Branch
22-
- Create a new branch for your contribution:
23-
```bash
24-
git checkout -b feature-branch
25-
```
26-
27-
---
28-
29-
## Contribution Workflow
30-
31-
### 1.Choose an Issue associated with the label **hacktoberfest**
32-
- Choose the Issue associated with the label hacktoberfest and clearly read all the details and acceptance criteria for the issue before starting to work on the issue.
33-
34-
### 2. Make Your Changes
35-
- Work on your branch locally. Implement your changes and test them thoroughly to ensure they work correctly.
36-
- For any UI changes, please include screenshots in the pull request.
37-
38-
### 3. Commit Your Changes
39-
- Commit messages should be clear and concise. Follow the format:
40-
```
41-
git commit -m "Add feature X to improve performance"
42-
```
43-
- Make sure your commit is properly documented and explains the **why** and **what** of the changes.
44-
45-
### 4. Push Your Changes
46-
- Push your branch to GitHub:
47-
```bash
48-
git push origin feature-branch
49-
```
50-
51-
### 5. Submit a Pull Request (PR)
52-
- Navigate to your fork on GitHub and click the **Pull Request** button.
53-
- Ensure your PR:
54-
- References the related issue number (e.g., `Fixes #123`).
55-
- Provides a clear description of what was changed and why.
56-
- Includes relevant tests or screenshots where applicable.
57-
- follow the Pull Request template.
58-
59-
---
60-
61-
## Code Guidelines
62-
63-
- Keep your code readable, maintainable, and well-documented.
64-
65-
### 1. Documentation
66-
- Update documentation as necessary. If your change impacts functionality, be sure to update the corresponding documentation in the **Help** or **README** files.
67-
68-
---
69-
70-
## Issue Reporting
71-
72-
### 1. Suggesting Enhancements
73-
- If you have ideas for new features, improvements, or optimizations, submit them through a GitHub issue and tag it with **enhancement**.
74-
75-
---
76-
77-
## Community
78-
79-
- If you have any questions or need guidance, feel free to or reach out via email sritammiraja.iragavarapu@slu.edu
80-
81-
Thank you for your contributions!
1+
# Contributing to Digital Bones Box
2+
3+
Thank you for checking out **Digital Bones Box**! We are so happy you are here. If you are intrested in contributing to the project below are some guidelines that help us make most out of your contribution.
4+
5+
## Getting Started
6+
7+
### How to Contribute
8+
9+
### 1. **Fork the Repository**
10+
- Navigate to the Digital Bones Box repository on GitHub
11+
- Click the "Fork" button on the top right of the repository page to create your own copy.
12+
13+
14+
### 2. **Clone Your Fork**
15+
- Clone the repository to your local machine:
16+
```bash
17+
git clone https://github.com/oss-slu/DigitalBonesBox
18+
cd your-repo
19+
20+
21+
### 3. Create a New Branch
22+
- Create a new branch for your contribution:
23+
```bash
24+
git checkout -b feature-branch
25+
```
26+
27+
---
28+
29+
## Contribution Workflow
30+
31+
### 1.Choose an Issue associated with the label **hacktoberfest**
32+
- Choose the Issue associated with the label hacktoberfest and clearly read all the details and acceptance criteria for the issue before starting to work on the issue.
33+
34+
### 2. Make Your Changes
35+
- Work on your branch locally. Implement your changes and test them thoroughly to ensure they work correctly.
36+
- For any UI changes, please include screenshots in the pull request.
37+
38+
### 3. Commit Your Changes
39+
- Commit messages should be clear and concise. Follow the format:
40+
```
41+
git commit -m "Add feature X to improve performance"
42+
```
43+
- Make sure your commit is properly documented and explains the **why** and **what** of the changes.
44+
45+
### 4. Push Your Changes
46+
- Push your branch to GitHub:
47+
```bash
48+
git push origin feature-branch
49+
```
50+
51+
### 5. Submit a Pull Request (PR)
52+
- Navigate to your fork on GitHub and click the **Pull Request** button.
53+
- Ensure your PR:
54+
- References the related issue number (e.g., `Fixes #123`).
55+
- Provides a clear description of what was changed and why.
56+
- Includes relevant tests or screenshots where applicable.
57+
- follow the Pull Request template.
58+
59+
---
60+
61+
## Code Guidelines
62+
63+
- Keep your code readable, maintainable, and well-documented.
64+
65+
### 1. Documentation
66+
- Update documentation as necessary. If your change impacts functionality, be sure to update the corresponding documentation in the **Help** or **README** files.
67+
68+
---
69+
70+
## Issue Reporting
71+
72+
### 1. Suggesting Enhancements
73+
- If you have ideas for new features, improvements, or optimizations, submit them through a GitHub issue and tag it with **enhancement**.
74+
75+
---
76+
77+
## Community
78+
79+
- If you have any questions or need guidance, feel free to or reach out via email wendy.onwuagana@slu.edu or daniel.shown@slu.edu
80+
81+
Thank you for your contributions!
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
### Finding Your First Contribution
2+
Welcome to the DigitalBoneBox project! We're thrilled you're interested in contributing. This guide is designed to help you find and complete your first issue.
3+
4+
### What is a "Good First Issue"?
5+
A "Good First Issue" is a task that has been specifically identified by our team as being a great entry point for new contributors. These issues are typically:
6+
7+
1. Well-defined: The goal is clear and the scope is small.
8+
9+
2. Low-impact: They don't involve changing critical parts of the application.
10+
11+
3. A great learning opportunity: They are a perfect way to get familiar with our codebase, our contribution workflow, and our team.
12+
13+
Examples of good first issues in this project might include:
14+
15+
Fixing a typo in the UI.
16+
17+
Improving the styling of a button or a menu.
18+
19+
Adding a small, self-contained feature, like a "Back to Top" button.
20+
21+
Improving the comments or documentation in a specific part of the code.
22+
23+
### How to Find a Good First Issue
24+
We use a specific label on GitHub to mark these tasks. You can find a good first issue by looking at our wide range of issues created in our repo and identifying an issue tagged "Good First Issue".
25+
26+
### Your First Contribution Workflow
27+
Once you've found an issue that interests you, here’s how to get started:
28+
29+
1. Claim the Issue: Let everyone know you're working on it! You can assign the issue to yourself by clicking the "assign" button in the sidebar on the right of the issue page. It's also a good idea to leave a quick comment like, "I'd like to work on this!" This helps us avoid having multiple people working on the same thing.
30+
31+
2. Follow the Contribution Guide: Our main CONTRIBUTING.md file has all the technical steps you need to get the project set up on your local machine. Please follow it carefully to fork the repository, create your branch, and run the application.
32+
33+
3. Work on the Code: Make the necessary changes to the code to address the issue.
34+
35+
4. Submit a Pull Request: Once you're finished, submit a pull request. we have a pull request template we use for our project which you can use for your reference under ISSUE_TEMPLATE. Once that is done, Our team will then review your work.
36+
37+
### Questions or Need Help?
38+
We're here to help you succeed! If you get stuck, have a question, or just want to discuss an idea, please don't hesitate to:
39+
40+
Leave a comment on the issue you're working on.
41+
42+
Reach out to the project maintainers via the contact information in our CONTRIBUTING.md file.
43+
44+
Thank you for your interest in contributing to DigitalBoneBox!

.github/ISSUE_TEMPLATE/taskcard.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: General Task Card
3+
about: For standard development tasks, chores, or refactoring.
4+
title: '[Task]: '
5+
labels: task, enhancement
6+
assignees: ''
7+
8+
---
9+
10+
### 🎯 Goal / Objective
11+
*A clear and concise description of what this task aims to achieve. Why is this task important for the sprint?*
12+
13+
---
14+
15+
### ✅ Tasks to be Completed
16+
*A checklist of the specific, actionable steps required to complete this issue. This helps track progress.*
17+
18+
- [ ] Task 1:
19+
- [ ] Task 2:
20+
- [ ] Task 3:
21+
22+
---
23+
24+
### Acceptance Criteria
25+
*A checklist of conditions that must be met for this task to be considered complete. How will we verify that it's done correctly?*
26+
27+
- [ ] The new feature is implemented as described.
28+
- [ ] All related code passes the repository's workflow checks (linting, tests).
29+
- [ ] The application runs without errors after the changes are made.
30+
- [ ] (If applicable) New automated tests have been added to cover the changes.
31+
32+
---
33+
34+
### Additional Context
35+
*Add any other context, notes, screenshots, or links that might be helpful for completing this task.*

DigitalBonesBox

Whitespace-only changes.

merge_annotations_into_final.py

Lines changed: 0 additions & 145 deletions
This file was deleted.

0 commit comments

Comments
 (0)