Skip to content

Commit 3a88b9e

Browse files
authored
chore: update project context (#190)
1 parent b182889 commit 3a88b9e

File tree

6 files changed

+64
-61
lines changed

6 files changed

+64
-61
lines changed

.github/CONTRIBUTING.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
> Thanks for contributing!
1+
> Thanks for being interested in contributing to this project!
22
33
# Raising an Issue
44

@@ -7,6 +7,7 @@
77

88
# Submitting a Pull Request
99

10+
- Before you start working, it's better to open an issue to discuss first.
1011
- The current developed version is in the `main` branch. The theme does not have a dedicated `develop` branch
1112
- Include **screenshots** or animated GIFs in your pull request whenever needed (if visual changes)
1213
- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging
@@ -20,18 +21,30 @@
2021
- **Use .scss extension**
2122
- **Use kebab-case**
2223

24+
### Transitions / Animations GPU-based only
25+
26+
The only properties that uses hardware acceleration are:
27+
28+
- transform
29+
- opacity
30+
- filter
31+
32+
These are two great articles about it: https://medium.com/outsystems-experts/how-to-achieve-60-fps-animations-with-css3-db7b98610108 and https://www.sitepoint.com/introduction-to-hardware-acceleration-css-animations/.
33+
2334
# Development Setup
2435

2536
You need at least [Node.js](http://nodejs.org/) **version 22**.
2637
The local setup contains every example of the main Oruga documentation page.
2738

28-
After cloning the repository, install the dependencies:
39+
## Install
40+
41+
Clone this repo to your local machine and install the dependencies:
2942

3043
```bash
3144
$ npm install
3245
```
3346

34-
## Link the main repo locally
47+
### Link the main repo locally
3548

3649
To link the main Oruga packages locally, build both the `oruga` and the `examples` package in the Oruga repo.
3750
Then run `npm run link ../oruga/packages/oruga ../oruga/packages/examples` in the theme repo to link the build output of the main Oruga packages.

CONTRIBUTORS.md renamed to .github/CONTRIBUTORS.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,3 @@
77
src="https://contrib.rocks/image?repo=oruga-ui/theme-bootstrap"
88
/>
99
</a>
10-
11-
<!-- ## Extra contributions
12-
13-
- [name](link) -->

CODE_OF_CONDUCT.md

Lines changed: 45 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,42 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
11-
12-
## Our Standards
13-
14-
Examples of behavior that contributes to creating a positive environment
15-
include:
16-
17-
- Using welcoming and inclusive language
18-
- Being respectful of differing viewpoints and experiences
19-
- Gracefully accepting constructive criticism
20-
- Focusing on what is best for the community
21-
- Showing empathy towards other community members
22-
23-
Examples of unacceptable behavior by participants include:
24-
25-
- The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
- Trolling, insulting/derogatory comments, and personal or political attacks
28-
- Public or private harassment
29-
- Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
- Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
5+
We pledge to make our community welcoming, safe, and equitable for all.
6+
7+
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
8+
9+
## Encouraged Behaviors
10+
11+
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
12+
13+
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
14+
15+
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
16+
2. Engaging **kindly and honestly** with others.
17+
3. Respecting **different viewpoints** and experiences.
18+
4. **Taking responsibility** for our actions and contributions.
19+
5. Gracefully giving and accepting **constructive feedback**.
20+
6. Committing to **repairing harm** when it occurs.
21+
7. Behaving in other ways that promote and sustain the **well-being of our community**.
22+
23+
## Restricted Behaviors
24+
25+
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
26+
27+
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
28+
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
29+
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
30+
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
31+
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
32+
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
33+
7. Behaving in other ways that **threaten the well-being** of our community.
34+
35+
### Other Restrictions
36+
37+
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
38+
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
39+
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
40+
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
3341

3442
## Our Responsibilities
3543

@@ -43,34 +51,20 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
4351
permanently any contributor for other behaviors that they deem inappropriate,
4452
threatening, offensive, or harmful.
4553

46-
## Scope
54+
## Reporting an Issue
4755

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
56+
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
5457

55-
## Enforcement
58+
When an incident does occur, it is important to report it promptly. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected].
5659

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at [email protected]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
60+
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
6361

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
62+
## Scope
6763

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

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
66+
## Attribution
7267

73-
[homepage]: https://www.contributor-covenant.org
68+
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
7469

75-
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
70+
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Oruga
3+
Copyright (c) 2025 Oruga
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Thank you to everyone involved for improving this project, day by day 💚
135135
/>
136136
</a>
137137

138-
[Complete list](CONTRIBUTORS.md).
138+
[Complete list](.github/CONTRIBUTORS.md).
139139

140140
## Credits
141141

src/views/Home.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="content">
33
<img
44
class="image__oruga"
5-
src="https://raw.githubusercontent.com/oruga-ui/theme-bootstrap/master/public/logo.svg"
5+
src="https://raw.githubusercontent.com/oruga-ui/theme-bootstrap/main/public/logo.svg"
66
alt="Logo Oruga Theme Bootstrap" />
77
<h1 class="mt-2">Oruga Bootstrap Theme Demo</h1>
88
</div>

0 commit comments

Comments
 (0)