Skip to content

Commit

Permalink
DOC Add default health files
Browse files Browse the repository at this point in the history
  • Loading branch information
emteknetnz committed Jun 23, 2023
1 parent 0f07166 commit e95ce36
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing

Any open source product is only as good as the community behind it. You can participate by sharing code, ideas, or simply helping others. No matter what your skill level is, every contribution counts.

See our [high level overview](https://silverstripe.org/contributing-to-silverstripe) on silverstripe.org on how you can help out.

## Copyright

**IMPORTANT: By supplying code to the SilverStripe core team in patches, tickets and pull requests, you agree to assign copyright of that code to SilverStripe Limited, on the condition that SilverStripe Limited releases that code under the BSD license.**

We ask for this so that the ownership in the license is clear and unambiguous, and so that community involvement doesn't stop us from being able to continue supporting these projects. By releasing this code under a permissive license, this copyright assignment won't prevent you from using the code in any way you see fit.

## Contributing code

Read the guide on [contributing code](https://docs.silverstripe.org/en/contributing/code/).

## Reporting security issues

Please report security issues to [security@silverstripe.org](mailto:security@silverstripe.org) rather than raising a public facing github issue.

For more infomation read about [reporting security issues](https://docs.silverstripe.org/en/5/contributing/issues_and_bugs/#reporting-security-issues).

## Code of conduct

Read the [code of conduct](https://docs.silverstripe.org/en/project_governance/code_of_conduct/) guide.
39 changes: 39 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Support

The issue tracker is reserved for reporting bugs and we don't provide support through it. Support tickets opened via the issue tracker will be closed.

If you require support there are two types of support available: community support and commercial support.

## Community support

Community support is provided by members of our open source community and is provided out of their good will. Please be kind, polite and corteous to those that try to help you; you may wish to refer to our [code of conduct](https://docs.Silverstripe.org/en/contributing/code_of_conduct/).

You can find support via:

- [Slack](https://Silverstripe.org/slack)
- [Forum](https://forum.Silverstripe.org)
- [Stack Overflow (remember to tag as Silverstripe)](https://stackoverflow.com/questions/tagged/Silverstripe)

We recommend choosing the support forum based on the nature of your question:

### Are you looking for an answer to a quick question or a recommendation for an approach or suitable Silverstripe module?

The Silverstripe community Slack has a wealth of active Silverstripe developers active daily. Remember that those who contribute usually do so in their free time so be considerate when messaging people directly. Consider if your issue might benefit another developer before choosing Slack. An alternate forum like StackOverflow may help other developers that are experiencing the same issue find a resolution.

### Are you looking for detailed feedback on a suggestion or module you have developed?

Try starting a discussion in the community forum. Developers and users alike use the forum to keep up to date with the Silverstripe community and contributions that people are making or discussing.

### Do you have some code you've tried that isn't working?

Your question will likely be best on Stack Overflow. You can add some detail about what you're trying to achieve and include some code that you have tried. Stack Overflow is a good forum for answers to be detailed and become available in the future for other developers in your position. Remember to [follow the guidance on Stack Overflow](https://stackoverflow.com/help/how-to-ask) for asking good questions!

### More information

For more information please see our [community page](https://www.silverstripe.org/community/#introduction).

## Commercial support

If you require a higher level of support with an SLA, you may want to consider commercial support provided by Silverstripe Ltd, a Professional Partner or another Silverstripe agency.

Please see the [Silverstripe Developer Directory](https://www.silverstripe.org/community/developer-and-partner-directory/) for more information.
19 changes: 19 additions & 0 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Developer documentation

See [docs.silverstripe.org](https://docs.silverstripe.org) for developer documentation.

### API documention

See [api.silverstripe.org](https://api.silverstripe.org) for automatically generated API documentation.

### Getting support

See [SUPPORT.md](SUPPORT.md) for information on getting support.

### Contributing code

See [CONTRIBUTING.md](CONTRIBUTING.md) for information on contribute code, reporting security issues and code of conduct.

### General issue tracking

This repository is also used to track meta issues affecting a wide-ranging list of Silverstripe CMS modules. E.g. broken builds, changing CI configuration across multiple repos, issues on repos not in the `silverstripe` organisation, etc.

0 comments on commit e95ce36

Please sign in to comment.