Skip to content

Commit 6aaa0c7

Browse files
devondragondevondragon
authored
Create CONTRIBUTING.md
1 parent 186ad61 commit 6aaa0c7

1 file changed

Lines changed: 149 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
Certainly! Below is a comprehensive `CONTRIBUTING.md` guide tailored for your GitHub project, [SpringUserFramework](https://github.com/devondragon/SpringUserFramework/). This guide outlines the preferred workflow for addressing issues and submitting pull requests (PRs), ensuring a smooth collaboration process.
2+
3+
---
4+
5+
# Contributing to SpringUserFramework
6+
7+
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.
8+
9+
## Table of Contents
10+
11+
- [Code of Conduct](#code-of-conduct)
12+
- [Getting Started](#getting-started)
13+
- [Forking the Repository](#forking-the-repository)
14+
- [Cloning Your Fork](#cloning-your-fork)
15+
- [Setting Up the Upstream Remote](#setting-up-the-upstream-remote)
16+
- [Working on Issues](#working-on-issues)
17+
- [Creating a Feature Branch](#creating-a-feature-branch)
18+
- [Making Changes](#making-changes)
19+
- [Committing Changes](#committing-changes)
20+
- [Pushing Changes](#pushing-changes)
21+
- [Submitting a Pull Request](#submitting-a-pull-request)
22+
- [Code Style and Standards](#code-style-and-standards)
23+
- [Testing](#testing)
24+
- [Documentation](#documentation)
25+
- [Community Support](#community-support)
26+
27+
## Code of Conduct
28+
29+
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.
30+
31+
## Getting Started
32+
33+
### Forking the Repository
34+
35+
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.
36+
37+
1. Navigate to the [SpringUserFramework repository](https://github.com/devondragon/SpringUserFramework/).
38+
2. Click the "Fork" button in the upper right corner.
39+
40+
### Cloning Your Fork
41+
42+
Next, clone your fork to your local machine to start making changes.
43+
44+
```bash
45+
git clone https://github.com/your-username/SpringUserFramework.git
46+
cd SpringUserFramework
47+
```
48+
49+
50+
### Setting Up the Upstream Remote
51+
52+
To keep your fork synchronized with the original repository, add it as an upstream remote:
53+
54+
```bash
55+
git remote add upstream https://github.com/devondragon/SpringUserFramework.git
56+
```
57+
58+
59+
This setup allows you to fetch updates from the main repository and incorporate them into your fork.
60+
61+
## Working on Issues
62+
63+
We use GitHub Issues to track bugs and feature requests. Before starting work, please check existing issues to avoid duplication.
64+
65+
1. Browse the [Issues](https://github.com/devondragon/SpringUserFramework/issues) to find something you'd like to work on.
66+
2. Comment on the issue to let others know you're working on it.
67+
68+
### Creating a Feature Branch
69+
70+
For each issue, create a new branch in your local repository. This keeps your changes organized and makes it easier to manage multiple contributions.
71+
72+
1. Fetch the latest changes from the upstream repository:
73+
74+
```bash
75+
git fetch upstream
76+
```
77+
78+
79+
2. Check out the branch associated with the issue:
80+
81+
```bash
82+
git checkout upstream/branch-name
83+
```
84+
85+
86+
3. Create a new branch off of the issue branch:
87+
88+
```bash
89+
git checkout -b your-feature-branch
90+
```
91+
92+
93+
### Making Changes
94+
95+
Make your desired changes in your local repository. Ensure that your code adheres to the project's coding standards and includes appropriate documentation.
96+
97+
### Committing Changes
98+
99+
Commit your changes with clear and descriptive messages.
100+
101+
```bash
102+
git add .
103+
git commit -m "Brief description of your changes"
104+
```
105+
106+
107+
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages.
108+
109+
### Pushing Changes
110+
111+
Push your feature branch to your fork on GitHub:
112+
113+
```bash
114+
git push origin your-feature-branch
115+
```
116+
117+
118+
## Submitting a Pull Request
119+
120+
Once your changes are pushed to your fork, submit a pull request (PR) to the original repository:
121+
122+
1. Navigate to your fork on GitHub.
123+
2. Click the "Compare & pull request" button next to your feature branch.
124+
3. Ensure the base fork is `devondragon/SpringUserFramework` and the base branch is the issue branch you're addressing.
125+
4. Provide a clear title and description for your PR, referencing the issue number it addresses.
126+
5. Click "Create pull request."
127+
128+
Your PR will be reviewed by the maintainers. Please be responsive to feedback and willing to make adjustments as needed.
129+
130+
## Code Style and Standards
131+
132+
Please adhere to the following coding standards:
133+
134+
- Follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) for Java code.
135+
- Use meaningful variable and method names.
136+
- Write concise and clear comments where necessary.
137+
138+
Consistent code style helps maintain readability and ease of maintenance.
139+
140+
## Testing
141+
142+
Ensure that your changes do not break existing tests and include new tests as appropriate. Run all tests before submitting a PR:
143+
144+
```bash
145+
./gradlew test
146+
```
147+
148+
149+

0 commit comments

Comments
 (0)