Skip to content

Commit

Permalink
feat: add some samples for files (#184) (#185)
Browse files Browse the repository at this point in the history 
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
  • Loading branch information
@pylapp
pylapp committed Jan 27, 2025
1 parent 8d76c63 commit 7d8f28c
Show file tree
Hide file tree
Showing 13 changed files with 771 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased](https://github.com/Orange-OpenSource/floss-toolbox/compare/2.21.0..dev)

### Added

- Samples for common files to add in projects ([#184](https://github.com/Orange-OpenSource/floss-toolbox/issues/184))

## [2.21.0](https://github.com/Orange-OpenSource/floss-toolbox/compare/2.21.0..2.20.0) - 2024-09-164

### Added
Expand Down
13 changes: 13 additions & 0 deletions samples/AUTHORS.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# This is the official list of ouds-ios authors for copyright purposes.
# This file is distinct from the CONTRIBUTORS files.
# See the latter for an explanation.

# Names should be added to this file as one of
# Organization's name
# Individual's name <submission email address>
# Individual's name <submission email address> <email2> <emailN>
# See CONTRIBUTORS for the meaning of multiple email addresses.

# Please keep the list sorted.

Orange SA
35 changes: 35 additions & 0 deletions samples/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!-- Inspired by OUDS iOS file: https://github.com/Orange-OpenSource/ouds-ios/blob/develop/CHANGELOG.md -->

# CHANGELOG

All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<!-- For example:
## [Unreleased](https://github.com/Orange-OpenSource/ouds-ios/compare/0.8.0...develop)
or
## [0.8.0](https://github.com/Orange-OpenSource/ouds-ios/compare/0.7.0...0.8.0) - 2024-12-18
-->
## [Unreleased](project-url-pointinto-last-tag...default-branch)

<!-- TODO: Keep only non empty sections -->
### Added

...

### Changed

...

### Removed

...

### Fixed

...

### Security

...
130 changes: 130 additions & 0 deletions samples/CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
<!-- Inspired by OUDS iOS file: https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/CODE_OF_CONDUCT.md -->

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected] and [email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
165 changes: 165 additions & 0 deletions samples/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
<!-- Inspired by https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/CONTRIBUTING.md -->

<!-- TODO: Apply project name -->
# Contributing to {project-name}

<!-- TODO: Apply project name -->
Looking to contribute something {project-name}? **Here's how you can help.**

Please take a moment to review this document in order to make the contribution process easy for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this Open Source project.
In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

<!-- TODO: Keep section if a wiki exists -->
You should also have a look on the wiki if you are looking for information about how the project is managed, the releases and tests done, and how to do some actions.
[The wiki define the way to work anyone must agree]({project-wiki-url}). <!-- TODO: Apply project wiki URL -->

<!-- TODO: Keep section if a CoC exists -->
[The Code of Conduct]({project-CoC-url}) defines how we should interact together. <!-- TODO: Apply project CoC URL -->

## Using the Issue Tracker

<!-- TODO: Apply project issues tracker URL -->
The [issue tracker]({project-issues-tracker-url}) is the preferred channel for [bug reports](#bug-reports), [feature requests](#feature-requests) and [submitting pull requests](#pull-requests), but please respect the following restrictions:

<!-- TODO: Apply project discussions URL -->
- Please **do not** use the issue tracker for personal support requests. [GitHub Discussions]({project-discussions-url}) or our internal Orange communication tools are better places to get help.

- Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.

- Please **do not** post comments consisting solely of "+1" or ":thumbsup:". Use [GitHub's "reactions" feature](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) instead. We reserve the right to delete comments which violate this rule.

## Issues and Labels

Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:

- `feature` - Issues asking for a new feature to be added, or an existing one to be extended or modified. New features require a minor version bump (e.g., `v1.0.0` to `v1.1.0`) or a major version bump if public API broken (e.g., `v1.0.0` to `v2.0.0`)
- `help wanted` - Issues we need or would love help from the community to resolve.

<!-- TODO: Apply issues labels URL -->
For a complete look at our labels, see the [project labels page]({project-issues-labels-url}).

## Bug Reports

A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

1. **Use the GitHub issue search** &mdash; check if the issue has already been reported.

<!-- TODO: Apply suitable branch name, here is 'develop' -->
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `develop` in the repository.

3. **Isolate the problem** &mdash; ideally create a reduced reproducible test case.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What device(s) and OS experience the problem? Do other devices show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

> Short and descriptive example bug report title
>
> A summary of the issue and the browser/OS environment in which it occurs. If
> suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
>
> `<url>` - a link to the reduced test case
>
> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).
## Feature Requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to _you_ to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

## Pull requests

Good pull requests (patches, improvements, new features) are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

**Please ask first** before embarking on any **significant** pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. For trivial things, or things that don't require a lot of your time, you can go ahead and make a PR.

Please adhere to the [coding guidelines](#code-guidelines) used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Adhering to the following process is the best way to get your work included in the project:

1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork, and configure the remotes:

<!-- TODO: Apply project name -->
```bash
# Clone your fork of the repo into the current directory (use either SSH or HTTPS)
git clone https://github.com/<your-username>/{project-name}.git
# Navigate to the newly cloned directory
cd {project-name}
# Assign the original repo to a remote called "upstream" (use either SSH or HTTPS)
git remote add upstream https://github.com/Orange-OpenSource/{project-name}.git
```

2. If you cloned a while ago, get the latest changes from upstream:
<!-- TODO: Apply suitable branch name, here is 'develop' -->
```bash
git checkout develop
git pull upstream develop
```

<!-- TODO: Apply suitable branch name, here is 'develop' -->
3. Create a new topic branch (off the `develop` project development branch) to contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name> develop
```

4. Commit your changes in logical chunks. Use Git's [interactive rebase](https://help.github.com/articles/about-git-rebase/) feature to tidy up your commits before making them public. Refer also to [commits style](#commits-style).

5. Locally merge (or rebase) the upstream development branch into your topic branch:

```bash
git pull [--rebase] upstream develop
```

6. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

<!-- TODO: Change the branch name if needed, can be 'develop' or 'dev' etc. -->
7. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/) with a clear title and description against the `develop` branch.

<!-- TODO: Apply license -->
**IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work under the terms of the [{project-license-name}]({project-license-url}).

## Code Guidelines

### Checking Coding Style

Format your code before committing to ensure your changes follow our coding standards.

## Commits style

Try as best as possible to apply [conventional commits rules](https://www.conventionalcommits.org/en/v1.0.0/).
Keep in mind to have your commits well prefixed, and with the issue number between parenthesis at the end.
If your commits embed contributions for other people, do not forget to [add them as co-authors](https://docs.github.com/fr/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors). All of you should also comply to DCO.

For example, given a commit to fix the issue n°43, the commit should be like:

```text
fix: title of your commit (#43)
Some details about the fix you propose
Co-authored-by: First author firstname and lastname <first author email>
Co-authored-by: Second author firstname and lastname <second author email>
Signed-off-by: First author firstname and lastname <first author email>
Signed-off-by: Second author firstname and lastname <second author email>
```

## License

<!-- TODO: Apply license -->
By contributing your code, you agree to license your contribution under the [{project-license-name}]({project-license-url}).
21 changes: 21 additions & 0 deletions samples/CONTRIBUTORS.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This is the official list of people have contributed code to the
# {project-name}repository.
#
# The AUTHORS file lists the copyright holders; this file
# lists people. For example, Orange employees are listed here
# but not in AUTHORS, because Orange holds the copyright.
#
# When adding J Random Contributor's name to this file,
# either J's name or J's organization's name should be
# added to the AUTHORS file, depending on who holds the copyright.
#
# Names should be added to this file like so:
# Individual's name <submission email address>
# Individual's name <submission email address> <email2> <emailN>
#
# An entry with multiple email addresses specifies that the
# first address should be used in the submit logs and
# that the other addresses should be recognized as the
# same person.

# Please keep the list sorted.
Loading

0 comments on commit 7d8f28c

Please sign in to comment.