You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+39-41Lines changed: 39 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to SpringUserFramework
2
2
3
-
Thank you for considering contributing to SpringUserFramework! We appreciate your time and effort in improving our project. The following guidelines will help you navigate the contribution process.
3
+
Thank you for considering contributing to SpringUserFramework! We appreciate your time and effort in improving our project. The following guidelines will help you navigate the contribution process.
4
4
5
5
## Table of Contents
6
6
@@ -22,94 +22,94 @@ Thank you for considering contributing to SpringUserFramework! We appreciate you
22
22
23
23
## Code of Conduct
24
24
25
-
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
25
+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
26
26
27
27
## Getting Started
28
28
29
29
### Forking the Repository
30
30
31
-
To contribute to SpringUserFramework, begin by forking the repository to your GitHub account. This creates a personal copy of the project where you can make changes without affecting the original repository.
31
+
To contribute to SpringUserFramework, begin by forking the repository to your GitHub account. This creates a personal copy of the project where you can make changes without affecting the original repository.
32
32
33
-
1. Navigate to the [SpringUserFramework repository](https://github.com/devondragon/SpringUserFramework/).
34
-
2. Click the "Fork" button in the upper right corner.
33
+
1. Navigate to the [SpringUserFramework repository](https://github.com/devondragon/SpringUserFramework/).
34
+
2. Click the "Fork" button in the upper right corner.
35
35
36
36
### Cloning Your Fork
37
37
38
-
Next, clone your fork to your local machine to start making changes.
38
+
Next, clone your fork to your local machine to start making changes.
This setup allows you to fetch updates from the main repository and incorporate them into your fork.
54
+
55
+
This setup allows you to fetch updates from the main repository and incorporate them into your fork.
56
56
57
57
## Working on Issues
58
58
59
-
We use GitHub Issues to track bugs and feature requests. Before starting work, please check existing issues to avoid duplication.
59
+
We use GitHub Issues to track bugs and feature requests. Before starting work, please check existing issues to avoid duplication.
60
60
61
-
1. Browse the [Issues](https://github.com/devondragon/SpringUserFramework/issues) to find something you'd like to work on.
62
-
2. Comment on the issue to let others know you're working on it.
61
+
1. Browse the [Issues](https://github.com/devondragon/SpringUserFramework/issues) to find something you'd like to work on.
62
+
2. Comment on the issue to let others know you're working on it.
63
63
64
64
### Creating a Feature Branch
65
65
66
-
For each issue, create a new branch in your local repository. This keeps your changes organized and makes it easier to manage multiple contributions.
66
+
For each issue, create a new branch in your local repository. This keeps your changes organized and makes it easier to manage multiple contributions.
67
67
68
-
1. Fetch the latest changes from the upstream repository:
68
+
1. Fetch the latest changes from the upstream repository:
69
69
70
70
```bash
71
71
git fetch upstream
72
72
```
73
-
74
73
75
-
2. Check out the branch associated with the issue:
74
+
75
+
2. Check out the branch associated with the issue:
76
76
77
77
```bash
78
78
git checkout upstream/branch-name
79
79
```
80
-
81
80
82
-
3. Create a new branch off of the issue branch:
81
+
82
+
3. Create a new branch off of the issue branch:
83
83
84
84
```bash
85
85
git checkout -b your-feature-branch
86
86
```
87
-
87
+
88
88
89
89
### Making Changes
90
90
91
-
Make your desired changes in your local repository. Ensure that your code adheres to the project's coding standards and includes appropriate documentation.
91
+
Make your desired changes in your local repository. Ensure that your code adheres to the project's coding standards and includes appropriate documentation.
92
92
93
93
### Committing Changes
94
94
95
-
Commit your changes with clear and descriptive messages.
95
+
Commit your changes with clear and descriptive messages.
96
96
97
97
```bash
98
98
git add .
99
99
git commit -m "Brief description of your changes"
100
100
```
101
-
102
101
103
-
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages.
102
+
103
+
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages.
104
104
105
105
### Pushing Changes
106
106
107
-
Push your feature branch to your fork on GitHub:
107
+
Push your feature branch to your fork on GitHub:
108
108
109
109
```bash
110
110
git push origin your-feature-branch
111
111
```
112
-
112
+
113
113
114
114
115
115
## Unit Tests and Test Coverage
@@ -138,15 +138,15 @@ We may add code coverage reporting tools in the future to help enforce this, but
138
138
139
139
## Submitting a Pull Request
140
140
141
-
Once your changes are pushed to your fork, submit a pull request (PR) to the original repository:
141
+
Once your changes are pushed to your fork, submit a pull request (PR) to the original repository:
142
142
143
-
1. Navigate to your fork on GitHub.
144
-
2. Click the "Compare & pull request" button next to your feature branch.
145
-
3. Ensure the base fork is `devondragon/SpringUserFramework` and the base branch is the issue branch you're addressing.
146
-
4. Provide a clear title and description for your PR, referencing the issue number it addresses.
147
-
5. Click "Create pull request."
143
+
1. Navigate to your fork on GitHub.
144
+
2. Click the "Compare & pull request" button next to your feature branch.
145
+
3. Ensure the base fork is `devondragon/SpringUserFramework` and the base branch is the issue branch you're addressing.
146
+
4. Provide a clear title and description for your PR, referencing the issue number it addresses.
147
+
5. Click "Create pull request."
148
148
149
-
Your PR will be reviewed by the maintainers. Please be responsive to feedback and willing to make adjustments as needed.
149
+
Your PR will be reviewed by the maintainers. Please be responsive to feedback and willing to make adjustments as needed.
150
150
151
151
152
152
## Contributing to the Demo Frontend
@@ -215,20 +215,18 @@ To test updates to the library before submitting a pull request, follow these st
215
215
216
216
## Code Style and Standards
217
217
218
-
Please adhere to the following coding standards:
218
+
Please adhere to the following coding standards:
219
219
220
-
- Follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) for Java code.
221
-
- Use meaningful variable and method names.
222
-
- Write concise and clear comments where necessary.
220
+
- Follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) for Java code.
221
+
- Use meaningful variable and method names.
222
+
- Write concise and clear comments where necessary.
223
223
224
-
Consistent code style helps maintain readability and ease of maintenance.
224
+
Consistent code style helps maintain readability and ease of maintenance.
225
225
226
226
## Testing
227
227
228
-
Ensure that your changes do not break existing tests and include new tests as appropriate. Run all tests before submitting a PR:
228
+
Ensure that your changes do not break existing tests and include new tests as appropriate. Run all tests before submitting a PR:
0 commit comments