Skip to content

Commit 5626fdb

Browse files
committed
Updated supporting files
1 parent e24414c commit 5626fdb

2 files changed

Lines changed: 8 additions & 38 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,38 @@
1-
*This is a suggested `CONTRIBUTING.md` file template for use by open sourced Salesforce projects. The main goal of this file is to make clear the intents and expectations that end-users may have regarding this project and how/if to engage with it. Adjust as needed (especially look for `{project_slug}` which refers to the org and repo name of your project) and remove this paragraph before committing to your repo.*
1+
# Contributing Guide For Salesforce Insurance Cloud Code Samples
22

3-
# Contributing Guide For {NAME OF PROJECT}
4-
5-
This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to {PROJECT}. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes.
3+
This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to Salesforce Insurance Cloud Code Samples. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes.
64

75
# Governance Model
8-
> Pick the most appropriate one
9-
10-
## Community Based
11-
12-
The intent and goal of open sourcing this project is to increase the contributor and user base. The governance model is one where new project leads (`admins`) will be added to the project based on their contributions and efforts, a so-called "do-acracy" or "meritocracy" similar to that used by all Apache Software Foundation projects.
13-
14-
> or
15-
16-
## Salesforce Sponsored
17-
18-
The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given `admin` rights and will be the final arbitrars of what contributions are accepted or not.
19-
20-
> or
216

227
## Published but not supported
238

249
The intent and goal of open sourcing this project is because it may contain useful or interesting code/concepts that we wish to share with the larger open source community. Although occasional work may be done on it, we will not be looking for or soliciting contributions.
2510

26-
# Getting started
27-
28-
Please join the community on {Here list Slack channels, Email lists, Glitter, Discord, etc... links}. Also please make sure to take a look at the project [roadmap](ROADMAP.md) to see where are headed.
29-
3011
# Issues, requests & ideas
3112

3213
Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
3314

3415
### Bug Reports and Fixes
35-
- If you find a bug, please search for it in the [Issues](https://github.com/{project_slug}/issues), and if it isn't already tracked,
36-
[create a new issue](https://github.com/{project_slug}/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
16+
- If you find a bug, please search for it in the [Issues](https://github.com/SalesforceLabs/InsuranceCloudCodeSamples/issues), and if it isn't already tracked,
17+
[create a new issue](https://github.com/SalesforceLabs/InsuranceCloudCodeSamples/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
3718
be reviewed.
3819
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
3920
- If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
4021
- Include tests that isolate the bug and verifies that it was fixed.
4122

4223
### New Features
43-
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/{project_slug}/issues/new).
24+
- If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/SalesforceLabs/InsuranceCloudCodeSamples/issues/new).
4425
- Issues that have been identified as a feature request will be labelled `enhancement`.
4526
- If you'd like to implement the new feature, please wait for feedback from the project
4627
maintainers before spending too much time writing the code. In some cases, `enhancement`s may
4728
not align well with the project objectives at the time.
4829

4930
### Tests, Documentation, Miscellaneous
50-
- If you'd like to improve the tests, you want to make the documentation clearer, you have an
31+
- If you'd like to make the documentation clearer or you have an
5132
alternative implementation of something that may have advantages over the way its currently
5233
done, or you have any other change, we would be happy to hear about it!
5334
- If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
54-
- If not, [open an Issue](https://github.com/{project_slug}/issues/new) to discuss the idea first.
55-
56-
If you're new to our project and looking for some way to make your first contribution, look for
57-
Issues labelled `good first contribution`.
35+
- If not, [open an Issue](https://github.com/SalesforceLabs/InsuranceCloudCodeSamples/issues/new) to discuss the idea first.
5836

5937
# Contribution Checklist
6038

@@ -66,7 +44,6 @@ Issues labelled `good first contribution`.
6644
- [x] Tests
6745
- The test suite, if provided, must be complete and pass
6846
- Increase code coverage, not versa.
69-
- Use any of our testkits that contains a bunch of testing facilities you would need. For example: `import com.salesforce.op.test._` and borrow inspiration from existing tests.
7047
- [x] Dependencies
7148
- Minimize number of dependencies.
7249
- Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.

README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
11
# README
22

3-
A repo containing all the basic file templates and general guidelines for any open source project at Salesforce.
4-
5-
## Usage
6-
7-
It's required that all files must be placed at the top level of your repository.
8-
9-
> **NOTE** Your README should contain detailed, useful information about the project!
10-
3+
This repository contains Code Samples to implement Salesforce Insurance cloud features

0 commit comments

Comments
 (0)