mirror of
https://github.com/vegardit/docker-openldap.git
synced 2026-05-21 12:14:16 +02:00
docs: update docs
This commit is contained in:
parent
790ee02a85
commit
8920634c24
8
.github/workflows/build.yml
vendored
8
.github/workflows/build.yml
vendored
|
|
@ -3,12 +3,12 @@
|
||||||
# SPDX-License-Identifier: Apache-2.0
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
# SPDX-ArtifactOfProjectHomePage: https://github.com/vegardit/docker-openldap
|
# SPDX-ArtifactOfProjectHomePage: https://github.com/vegardit/docker-openldap
|
||||||
#
|
#
|
||||||
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
|
# https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax
|
||||||
name: Build
|
name: Build
|
||||||
|
|
||||||
on: # https://docs.github.com/en/actions/reference/events-that-trigger-workflows
|
on: # https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||||
schedule:
|
schedule:
|
||||||
# https://docs.github.com/en/actions/reference/choosing-when-your-workflow-runs/events-that-trigger-workflows
|
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#schedule
|
||||||
- cron: '0 17 * * 3'
|
- cron: '0 17 * * 3'
|
||||||
push:
|
push:
|
||||||
branches-ignore: # build all branches except:
|
branches-ignore: # build all branches except:
|
||||||
|
|
@ -33,7 +33,7 @@ on: # https://docs.github.com/en/actions/reference/events-that-trigger-workflow
|
||||||
- '.github/*.yml'
|
- '.github/*.yml'
|
||||||
- '.github/workflows/stale.yml'
|
- '.github/workflows/stale.yml'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
|
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#workflow_dispatch
|
||||||
|
|
||||||
|
|
||||||
defaults:
|
defaults:
|
||||||
|
|
|
||||||
8
.github/workflows/stale.yml
vendored
8
.github/workflows/stale.yml
vendored
|
|
@ -1,12 +1,12 @@
|
||||||
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
|
# https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax
|
||||||
name: Stale issues
|
name: Stale issues
|
||||||
|
|
||||||
on:
|
on: # https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows
|
||||||
schedule:
|
schedule:
|
||||||
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows
|
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#schedule
|
||||||
- cron: '0 15 1,15 * *'
|
- cron: '0 15 1,15 * *'
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
|
# https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#workflow_dispatch
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
issues: write
|
issues: write
|
||||||
|
|
|
||||||
|
|
@ -60,7 +60,7 @@ ## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
reported to the community leaders responsible for enforcement at
|
reported to the community leaders responsible for enforcement at
|
||||||
https://vegardit.com/about/legal/.
|
https://vegardit.com/legal/
|
||||||
All complaints will be reviewed and investigated promptly and fairly.
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
|
|
||||||
|
|
@ -1,25 +1,45 @@
|
||||||
# Contributing
|
# Contributing to the Project
|
||||||
|
|
||||||
Thanks for your interest in contributing to this project!
|
Thank you for your interest in contributing to this project! We strive to make the contribution process clear and welcoming.
|
||||||
|
|
||||||
We want to make contributing as easy and transparent as possible.
|
Please take a moment to review the guidelines below.
|
||||||
|
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
Our code of conduct is described in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
|
Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions with the project.
|
||||||
|
This helps us maintain a positive and respectful environment for everyone involved.
|
||||||
|
|
||||||
|
|
||||||
## Issues
|
## How to Contribute
|
||||||
|
|
||||||
We use GitHub issues to track bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
|
### Contributor Responsibilities
|
||||||
|
|
||||||
|
By submitting your contributions, you agree to the following:
|
||||||
|
- You are the sole author of the content you contribute, or you have the appropriate rights and permissions to contribute it.
|
||||||
|
- If employed, you have obtained any necessary permissions from your employer to contribute to this project.
|
||||||
|
- All contributions will be made available under the project’s license.
|
||||||
|
|
||||||
|
### Issues
|
||||||
|
|
||||||
|
We use GitHub Issues to track bugs and feature requests. When submitting an issue, please ensure:
|
||||||
|
- The description is clear and concise.
|
||||||
|
- You provide enough details and steps to reproduce the issue, if applicable.
|
||||||
|
|
||||||
|
### Pull Requests
|
||||||
|
|
||||||
|
Before making substantial contributions:
|
||||||
|
1. **Discuss Changes**: Please file an issue first to discuss your proposed changes with the team. This helps ensure your contribution aligns with the project’s goals.
|
||||||
|
2. **Follow Best Practices**: Adhere to the guidelines and ensure your code meets the project’s standards.
|
||||||
|
|
||||||
|
When submitting a pull request:
|
||||||
|
- Ensure your changes are well-documented.
|
||||||
|
- Include tests for any new features or significant changes.
|
||||||
|
- Reference the relevant issue(s) in your pull request description.
|
||||||
|
|
||||||
|
|
||||||
## Pull Requests
|
## Licensing
|
||||||
|
|
||||||
Before you make a substantial pull request, please file an issue and make sure someone from the team agrees that there is a problem or room for improvement.
|
By contributing to this project, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE.txt).
|
||||||
|
|
||||||
|
The project itself is also licensed under the [Apache License 2.0](LICENSE.txt)).
|
||||||
## License
|
|
||||||
|
|
||||||
By contributing your code, you agree to license your contribution under the [Apache License 2.0](LICENSE.txt).
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue