|
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! |
0 commit comments