-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #543 from Orange-OpenSource/develop
Release 0.13.0
- Loading branch information
Showing
361 changed files
with
6,496 additions
and
871 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "vendor/ods-jekyll-theme"] | ||
| path = vendor/ods-jekyll-theme | ||
| url = ../ods-jekyll-theme.git |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| # Contributing to Orange Design System Android | ||
|
|
||
| Looking to contribute something to Orange Design System Android? **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. | ||
|
|
||
| ## Using the Issue Tracker | ||
|
|
||
| The [issue tracker](https://github.com/Orange-OpenSource/ods-android/issues) 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: | ||
|
|
||
| - Please **do not** use the issue tracker for personal support requests. [GitHub Discussions](https://github.com/Orange-OpenSource/ods-android/discussions/categories/q-a) 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`). | ||
| - `help wanted` - Issues we need or would love help from the community to resolve. | ||
|
|
||
| For a complete look at our labels, see the [project labels page](https://github.com/Orange-OpenSource/ods-android/labels). | ||
|
|
||
| ## 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** — check if the issue has already been reported. | ||
|
|
||
| 2. **Check if the issue has been fixed** — try to reproduce it using the latest `main` in the repository. | ||
|
|
||
| 3. **Isolate the problem** — 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: | ||
|
|
||
| ```bash | ||
| # Clone your fork of the repo into the current directory | ||
| git clone https://github.com/<your-username>/ods-android.git | ||
| # Navigate to the newly cloned directory | ||
| cd ods-android | ||
| # Assign the original repo to a remote called "upstream" | ||
| git remote add upstream https://github.com/Orange-OpenSource/ods-android.git | ||
| ``` | ||
|
|
||
| 2. If you cloned a while ago, get the latest changes from upstream: | ||
|
|
||
| ```bash | ||
| git checkout main | ||
| git pull upstream main | ||
| ``` | ||
|
|
||
| 3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix: | ||
|
|
||
| ```bash | ||
| git checkout -b <topic-branch-name> | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| 5. Locally merge (or rebase) the upstream development branch into your topic branch: | ||
|
|
||
| ```bash | ||
| git pull [--rebase] upstream main | ||
| ``` | ||
|
|
||
| 6. Push your topic branch up to your fork: | ||
|
|
||
| ```bash | ||
| git push origin <topic-branch-name> | ||
| ``` | ||
|
|
||
| 7. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/) with a clear title and description against the `main` branch. | ||
|
|
||
| **IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work under the terms of the [MIT License](LICENSE). | ||
|
|
||
| ## Code Guidelines | ||
|
|
||
| ### Checking Coding Style | ||
|
|
||
| Format your code before committing to ensure your changes follow our coding standards. | ||
|
|
||
| ## License | ||
|
|
||
| By contributing your code, you agree to license your contribution under the [MIT License](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <h1 align="center">Orange Design System Android Demo Application</h1> | ||
|
|
||
| <p align="center"> | ||
| ODS Android provides Orange Android components to developers. | ||
| <br> | ||
| <a href="https://orange-opensource.github.io/ods-android"><strong>Visit ODS Android</strong></a> | ||
| <br> | ||
| <br> | ||
| <a href="https://github.com/Orange-OpenSource/ods-android/issues/new?assignees=B3nz01d&labels=bug%2Ctriage&template=bug_report.yml&title=%5BBug%5D%3A+Bug+Summary">Report bug</a> | ||
| · | ||
| <a href="https://github.com/Orange-OpenSource/ods-android/issues/new?assignees=B3nz01d&labels=feature%2Ctriage&template=feature_request.yml&title=%5Bfeature%5D%3A+">Request feature</a> | ||
| </p> |
Oops, something went wrong.