Skip to content

Commit 0e1bac5

Browse files
authored
Merge pull request #23 from baslu93/feature/readme-adjustments
docs: intall section moved up + badge link reference changed
2 parents 3cae0d4 + f573101 commit 0e1bac5

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,14 @@
11
# Analytics Connected-Objects Plugin
22

3-
[![npm](https://badgen.net/npm/v/plugin-analytics-connected-objects)](https://badgen.net/npm/v/plugin-analytics-connected-objects)
4-
[![downloads](https://badgen.net/npm/dw/plugin-analytics-connected-objects)](https://badgen.net/npm/dw/plugin-analytics-connected-objects)
3+
[![npm](https://badgen.net/npm/v/plugin-analytics-connected-objects)](https://www.npmjs.com/package/plugin-analytics-connected-objects)
4+
[![downloads](https://badgen.net/npm/dw/plugin-analytics-connected-objects)](https://www.npmjs.com/package/plugin-analytics-connected-objects)
55

66
The plugin enhances the productivity of CRMA developers and release managers by automating manual procedural tasks related to connected objects. Nowadays, each time a new field is used in recipes, the user tracks the field in notes. Later, when there's a need to migrate the recipe to a higher environment, the user manually checks off each field one by one in the connected objects according to the taken notes.
77

88
The process is highly manual, and forgetting to track certain fields often causes recipe run failures. The run failures highlight one field at a time, and the process should be repeated until the first successful run.
99

1010
The command, which can be executed locally or inserted into a CI/CD pipeline, verifies the required fields from the recipes and marks them in the environment within seconds.
1111

12-
## Issues
13-
14-
Please report any <a href="https://github.com/baslu93/plugin-analytics-connected-objects/issues/new?template=enhancement.md&title=feat%3A+%5BFEATURE+NAME%5D">new feature</a>
15-
or <a href="https://github.com/baslu93/plugin-analytics-connected-objects/issues/new?template=issue.md&title=bug%3A+%5BBUG+NAME%5D">bug</a>
16-
using this links.
17-
18-
## Contributing
19-
20-
1. Create a new issue before starting your project so that we can keep track of
21-
what you are trying to add/fix. That way, we can also offer suggestions or
22-
let you know if there is already an effort in progress.
23-
2. Fork this repository.
24-
3. Build the plugin locally.
25-
4. Write appropriate tests for your changes. Try to achieve at least 75% code coverage on any new code.
26-
Nuts are required, but code coverage will be based on unit tests only.
27-
5. Send us a pull request when you are done (linking the issue previously created).
28-
We'll review your code, suggest any needed changes, and merge it in.
29-
3012
## Install
3113

3214
Run the following command (if you are still using the old CLI, relace `sf` with `sfdx` or [move to the new CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_move_to_sf_v2.htm)):
@@ -45,6 +27,24 @@ CI Users: As the plugin is not signed, to install it from a Dockerfile or a scri
4527
echo 'y' | sf plugins install plugin-analytics-connected-objects
4628
```
4729

30+
## Issues
31+
32+
Please report any <a href="https://github.com/baslu93/plugin-analytics-connected-objects/issues/new?template=enhancement.md&title=feat%3A+%5BFEATURE+NAME%5D">new feature</a>
33+
or <a href="https://github.com/baslu93/plugin-analytics-connected-objects/issues/new?template=issue.md&title=bug%3A+%5BBUG+NAME%5D">bug</a>
34+
using this links.
35+
36+
## Contributing
37+
38+
1. Create a new issue before starting your project so that we can keep track of
39+
what you are trying to add/fix. That way, we can also offer suggestions or
40+
let you know if there is already an effort in progress.
41+
2. Fork this repository.
42+
3. Build the plugin locally.
43+
4. Write appropriate tests for your changes. Try to achieve at least 75% code coverage on any new code.
44+
Nuts are required, but code coverage will be based on unit tests only.
45+
5. Send us a pull request when you are done (linking the issue previously created).
46+
We'll review your code, suggest any needed changes, and merge it in.
47+
4848
## Commands
4949

5050
<!-- commands -->

0 commit comments

Comments
 (0)