Skip to content

Commit 39abf87

Browse files
Update the instruction order in contributing file and release file
1 parent f71fb17 commit 39abf87

2 files changed

Lines changed: 46 additions & 46 deletions

File tree

CONTRIBUTING.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,28 @@ Thanks for contributing! Please read this document to follow our conventions for
66
## Setting Up
77

88
1. Fork the repository and then clone down your fork
9-
2. Commit your code per the conventions below, and PR into the mParticle SDK master branch
9+
2. Commit your code per the conventions below, and PR into the mParticle SDK main branch
1010
3. Your PR title will be checked automatically against the below convention (view the commit history to see examples of a proper commit/PR title). If it fails, you must update your title
1111
4. Our engineers will work with you to get your code change implemented once a PR is up
1212

13+
14+
## Development Process
15+
16+
1. Fork the repo and create your branch from `main`
17+
2. Make your changes
18+
3. Add tests for any new functionality
19+
4. Run the test suite to ensure tests (both new and old) all pass
20+
6. Update the documentation
21+
7. Create a Pull Request
22+
23+
24+
### Pull Requests
25+
26+
* Fill in the required template
27+
* Follow the [Android style guide](https://developer.android.com/kotlin/style-guide)
28+
* Include screenshots and animated GIFs in your pull request whenever possible
29+
* End all files with a newline
30+
1331
### PR Title and Commit Convention
1432

1533
PR titles should follow conventional commit standards. This helps automate the release process.
@@ -38,42 +56,6 @@ The following lists the different types allowed in the commit message:
3856
- **revert**: Revert commit
3957
- **build**: Changes that affect the build system or other dependencies
4058

41-
42-
43-
### Reporting Bugs
44-
45-
This section guides you through submitting a bug report for the mParticle Android SDK. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
46-
47-
Before creating bug reports, please check [existing issues](https://github.com/mParticle/mparticle-android-sdk/issues) as you might find out that you don't need to create one.
48-
49-
**When you are creating a bug report, please include as many details as possible:**
50-
51-
* Use a clear and descriptive title
52-
* Describe the exact steps which reproduce the problem
53-
* Provide specific examples to demonstrate the steps
54-
* Describe the behavior you observed after following the steps
55-
* Explain which behavior you expected to see instead and why
56-
* Include logcat output and stack traces if applicable
57-
* Include your SDK version and Android OS version
58-
59-
60-
### Pull Requests
61-
62-
* Fill in the required template
63-
* Follow the [Android style guide](https://developer.android.com/kotlin/style-guide)
64-
* Include screenshots and animated GIFs in your pull request whenever possible
65-
* End all files with a newline
66-
67-
## Development Process
68-
69-
1. Fork the repo and create your branch from `main`
70-
2. Run the tests to ensure they all pass
71-
3. Add tests for any new functionality
72-
4. Make your changes
73-
5. Run the test suite to ensure tests still pass
74-
6. Update the documentation
75-
7. Create a Pull Request
76-
7759
### Testing
7860

7961
We use JUnit and Mockito for our testing framework. Please write tests for new code you create. Before submitting your PR, ensure all tests pass by running:
@@ -95,6 +77,24 @@ We use JUnit and Mockito for our testing framework. Please write tests for new c
9577

9678
Make sure all tests pass successfully before submitting your PR. If you encounter any test failures, investigate and fix the issues before proceeding.
9779

80+
81+
### Reporting Bugs
82+
83+
This section guides you through submitting a bug report for the mParticle Android SDK. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
84+
85+
To notify our team about an issue, please submit a ticket through our [mParticles support page](https://support.mparticle.com/hc/en-us/requests/new).
86+
87+
**When you are creating a ticket, please include as many details as possible:**
88+
89+
* Use a clear and descriptive title
90+
* Describe the exact steps which reproduce the problem
91+
* Provide specific examples to demonstrate the steps
92+
* Describe the behavior you observed after following the steps
93+
* Explain which behavior you expected to see instead and why
94+
* Include logcat output and stack traces if applicable
95+
* Include your SDK version and Android OS version
96+
97+
9898
## License
9999

100100
By contributing to the mParticle Android SDK, you agree that your contributions will be licensed under its [Apache License 2.0](LICENSE).

RELEASE.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@ This document outlines the process for releasing the mParticle Android SDK and i
44

55
## Step 1: Preparing the SDK for Release
66

7-
The Android SDK and kits are released through the [public repository](https://github.com/mParticle/mparticle-android-sdk) using GitHub Actions. The SDK and kits are currently coupled together in the release process.
7+
The Android SDK and kits are released using GitHub Actions. The SDK and kits are currently coupled together in the release process.
88

99
### Pre-release Checklist
10-
- Ensure all commits are in the public development branch
11-
- Verify linear history between development and main branches
10+
- Ensure all commits are in the public main branch
1211
- Review `release.yml` in the repo for specific workflow details
13-
- The release job deploys the most current snapshot of development branch to main branch
14-
> Note: We rarely merge anything to development branch that isn't ready for immediate release.
12+
- The release job deploys the most current snapshot of main branch release tag to main branch
13+
1514

1615
## Step 2: Release via GitHub Actions
1716

@@ -52,9 +51,10 @@ The Android SDK and kits are released through the [public repository](https://gi
5251

5352
1. Navigate to the Actions tab
5453
2. Select "release SDK"
55-
3. Run the workflow from main branch
56-
4. Select "not dry run"
57-
> Note: Dry run performs steps up to semantic release only
54+
3. Run the workflow from main branch with "dry run" option first
55+
> Important: Always start with a dry run to validate the release process. This will perform all steps up to semantic release without actually publishing, helping catch potential issues early.
56+
4. If the dry run succeeds, run the workflow again with "not dry run" option to perform the actual release
57+
> Note: Only proceed with the actual release after confirming a successful dry run
5858
5959
### Important Notes
6060

@@ -71,7 +71,7 @@ The Android SDK and kits are released through the [public repository](https://gi
7171

7272
After a successful build through GitHub Actions, verify:
7373
1. Public repo has a new semantic release tag
74-
2. New artifact is present in Sonatype
74+
2. New artifact is present in [Sonatype](https://central.sonatype.com/publishing)
7575

7676
## Troubleshooting
7777

0 commit comments

Comments
 (0)