Skip to content

Commit 3315fa2

Browse files
authored
Updated contributions.md and .gitignore (#34)
* Update contributions.md * Update .gitignore and steps in contributions.md
1 parent 303035e commit 3315fa2

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
build/
33
docs/_build/
44
.gradle/
5+
.idea/
6+
.vscode/

contributions.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,22 @@ and sent to [[email protected]](mailto:[email protected]?subject=Vulnera
2222
preferably with the title "Vulnerability in Github LinkedIn/DuaLip - < short summary >".
2323

2424
## Steps for Creating Pull Request
25-
1. Test build. (./gradlew build)
26-
2. Create a new branch locally. (git branch mybranch)
27-
3. Commit the changes locally. (git commit)
28-
4. **Don't forget to update project.version in build.gradle.** We follow the semantic versioning (major.minor.patch).
25+
1. Create a new local branch (git branch mybranch)
26+
2. Make code changes in local branch
27+
3. **Change major and/or minor version in `version.properties` if necessary**.
28+
We follow semantic versioning practices (major.minor.patch).
2929
* Increment Major for backward incompatible change.
3030
* Increment Minor for major function changes.
31-
* Increment Patch for bug fixes.
32-
5. **Also, don't forget to create a corresponding new tag locally and push to the original master.**
33-
* git tag vx.x.x
34-
* git push origin vx.x.x
31+
* Patch versionining and releases are handled automatically by CI/CD flows.
32+
4. Commit changes to local branch (git commit)
33+
5. Test build (./gradlew build)
3534
6. Push local changes to remote branch. (git push -f origin mybranch)
3635
7. Create a new pull request at https://github.com/linkedin/DuaLip/pulls
37-
8. If need to update the pull request, repeat step 2 to 3.
36+
8. If you need to update the pull request, repeat steps 2 through 6, **excluding step 3**.
3837
9. Getting review and approval. Squash and merge to main branch.
3938

4039
## Tips for Getting Your Pull Request Accepted
4140

4241
1. Make sure all new features are tested and the tests pass.
4342
2. Bug fixes must include a test case demonstrating the error that it fixes.
44-
3. Open an issue first and seek advice for your change before submitting a pull request. Large features which have never been discussed are unlikely to be accepted.
43+
3. Open an issue first and seek advice for your change before submitting a pull request. Large features which have never been discussed are unlikely to be accepted.

0 commit comments

Comments
 (0)