Skip to content

Commit 4ea43c8

Browse files
committed
Add basic CONTRIBUTING.md
1 parent 824788a commit 4ea43c8

File tree

2 files changed

+77
-2
lines changed

2 files changed

+77
-2
lines changed

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
9+
## Pull Request Process
10+
11+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
12+
2. Update the README.md with details of changes to reflect important changes (new options, changed API, etc).
13+
3. Regenerate dist assets using production env: `npm run prod`.
14+
15+
16+
## Code of Conduct
17+
18+
### Our Pledge
19+
20+
In the interest of fostering an open and welcoming environment, we as
21+
contributors and maintainers pledge to making participation in our project and
22+
our community a harassment-free experience for everyone, regardless of age, body
23+
size, disability, ethnicity, gender identity and expression, level of experience,
24+
nationality, personal appearance, race, religion, or sexual identity and
25+
orientation.
26+
27+
28+
### Our Standards
29+
30+
Examples of behavior that contributes to creating a positive environment
31+
include:
32+
33+
* Using welcoming and inclusive language
34+
* Being respectful of differing viewpoints and experiences
35+
* Gracefully accepting constructive criticism
36+
* Focusing on what is best for the community
37+
* Showing empathy towards other community members
38+
39+
Examples of unacceptable behavior by participants include:
40+
41+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
42+
* Trolling, insulting/derogatory comments, and personal or political attacks
43+
* Public or private harassment
44+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
45+
* Other conduct which could reasonably be considered inappropriate in a professional setting
46+
47+
48+
### Our Responsibilities
49+
50+
Project maintainers are responsible for clarifying the standards of acceptable
51+
behavior and are expected to take appropriate and fair corrective action in
52+
response to any instances of unacceptable behavior.
53+
54+
Project maintainers have the right and responsibility to remove, edit, or
55+
reject comments, commits, code, wiki edits, issues, and other contributions
56+
that are not aligned to this Code of Conduct, or to ban temporarily or
57+
permanently any contributor for other behaviors that they deem inappropriate,
58+
threatening, offensive, or harmful.
59+
60+
61+
### Scope
62+
63+
This Code of Conduct applies both within project spaces and in public spaces
64+
when an individual is representing the project or its community. Examples of
65+
representing a project or community include using an official project e-mail
66+
address, posting via an official social media account, or acting as an appointed
67+
representative at an online or offline event. Representation of a project may be
68+
further defined and clarified by project maintainers.

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Nova Unlayer Field
22

3-
⚠️ This package is under active development
4-
53
[![Latest Stable Version](https://poser.pugx.org/interaction-design-foundation/nova-unlayer-field/v/stable)](https://packagist.org/packages/idf/nova-unlayer-field)
64
[![Total Downloads](https://poser.pugx.org/interaction-design-foundation/nova-unlayer-field/downloads)](https://packagist.org/packages/idf/nova-unlayer-field)
75

86
Adds a Laravel Nova field for Unlayer to compose emails and landing pages.
97

108
![image](https://github.com/InteractionDesignFoundation/nova-unlayer-field/blob/master/resources/img/[email protected])
119

10+
11+
1212
## Installation
1313

1414
You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
@@ -17,6 +17,7 @@ You can install the package in to a Laravel app that uses [Nova](https://nova.la
1717
composer require interaction-design-foundation/nova-unlayer-field
1818
```
1919

20+
2021
## Usage
2122

2223
This package assumes that your Model has an attribute to store design config
@@ -42,6 +43,7 @@ public function fields()
4243
}
4344
```
4445

46+
4547
### Options
4648
- `->config(array|callable $config)`: Specify [Unlayer config](https://docs.unlayer.com/docs/getting-started#section-configuration-options).
4749
- `->height(string $height)`: Set height of the editor (with units). E.g. '1000px' (800px by default).
@@ -56,14 +58,18 @@ Unlayer::make('Design')->config([
5658
$newsletterModel->html = $request->input($htmlFieldName);
5759
}),
5860
````
61+
62+
5963
### Changelog
6064

6165
Please see [Releases](https://github.com/InteractionDesignFoundation/nova-unlayer-field/releases) for more information on what has changed recently.
6266

67+
6368
## Contributing
6469

6570
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
6671

72+
6773
### Compiling Assets
6874

6975
```bash
@@ -77,6 +83,7 @@ npm run dev
7783
npm run watch
7884
```
7985

86+
8087
## License
8188

8289
The MIT License (MIT). Please see [License File](LICENSE) for more information.

0 commit comments

Comments
 (0)