Skip to content

Commit 426c27d

Browse files
author
Maya Shavin
committed
Merge branch 'master' into remove-unused-install-options
2 parents c352b0f + e2febff commit 426c27d

File tree

2 files changed

+144
-42
lines changed

2 files changed

+144
-42
lines changed

‎CONTRIBUTING.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Contributing to Cloudinary Vue SDK
2+
3+
Contributions are welcome and greatly appreciated!
4+
5+
## Reporting a bug
6+
7+
- Ensure that the bug was not already reported by searching in GitHub under [Issues](https://github.com/cloudinary/cloudinary-vue/issues) and the Cloudinary [Support forms](https://support.cloudinary.com).
8+
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/cloudinary/cloudinary-vue/issues/new).
9+
Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
10+
- If you require assistance in the implementation of Cloudinary Vue SDK please [submit a request](https://support.cloudinary.com/hc/en-us/requests/new) in the Cloudinary web site.
11+
12+
## Requesting a feature
13+
14+
We would love to hear your requests!
15+
Please be aware that the package is used in a wide variety of environments and that some features may not be applicable to all users.
16+
17+
- [Open a GitHub issue](https://github.com/cloudinary/cloudinary-vue/issues/new) describing the benefits (and possible drawbacks) of the requested feature
18+
19+
## Fixing a bug / Implementing a new feature
20+
21+
- Follow the instructions detailed in [Code contribution](#code-contribution)
22+
- Open a new GitHub pull request
23+
- Ensure the PR description clearly describes the bug / feature. Include the relevant issue number if applicable.
24+
- Provide test code that covers the new code
25+
26+
## Code contribution
27+
28+
When contributing code, either to fix a bug or to implement a new feature, please follow these guidelines:
29+
30+
#### Fork the Project
31+
32+
Fork [project on Github](https://github.com/cloudinary/cloudinary-vue) and check out your copy.
33+
34+
```sh
35+
# clone repository and name your remote "fork"
36+
git clone https://github.com/[CONTRIBUTOR]/cloudinary-vue.git -o fork
37+
# enter newly created directory
38+
cd cloudinary-vue
39+
# add original Cloudinary Vue SDK remote location as "origin"
40+
git remote add origin https://github.com/cloudinary/cloudinary-vue.git
41+
```
42+
43+
#### Install prerequisites
44+
45+
```sh
46+
# in repository folder
47+
npm i -g @vue/cli
48+
npm i
49+
```
50+
51+
#### Create a Topic Branch
52+
53+
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
54+
55+
```sh
56+
# checkout onto and refresh master branch
57+
git checkout master
58+
git pull origin master
59+
# create a new feature/fix branch off of it
60+
git checkout -b my-feature-branch
61+
```
62+
63+
#### Rebase
64+
65+
If you've been working on a change for a while, rebase with origin/master before submitting a PR.
66+
67+
```sh
68+
git fetch origin
69+
git rebase origin/master
70+
git push origin my-feature-branch -f
71+
```
72+
73+
#### Write Tests
74+
75+
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
76+
77+
**We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.**
78+
79+
#### Write Code
80+
81+
Implement your feature or bug fix.
82+
**Make sure that tests completes without errors.**
83+
84+
#### Write Documentation
85+
86+
Document your changes in the [README](README.md) and also \*.md files specific for every component.
87+
88+
#### Running the tests
89+
90+
Run the basic test suite with `npm t`.
91+
92+
**Make sure that tests completes without errors.**
93+
Travis-CI will run the full suite as well when you submit your pull request.
94+
95+
Preview styleguidist live documentation with `npm run styleguide` to verify results.
96+
97+
#### Commit Changes
98+
99+
Check the code with `npm run lint` and fix any indicated issues.
100+
101+
Make sure git knows your name and email address:
102+
103+
```
104+
git config --global user.name "Your Name"
105+
git config --global user.email "contributor@example.com"
106+
```
107+
108+
Please don't include build system or documentation artifacts in your PR unless it is precisely what you aim to do. If so, `npm run build` produces essential package files and outputs documentation files.
109+
110+
Please squash your commits into a single commit when appropriate. This simplifies future cherry picks and keeps the git log clean.
111+
112+
Writing good commit logs is important. A commit log should describe what changed and why. Commit message/name should be in form of a task description, ie. `"add support for some feature"`. Upon commiting tests will be run again, so expect some delay in processing that request.
113+
114+
```
115+
git add ...
116+
git commit
117+
```
118+
119+
#### Push
120+
121+
```
122+
git push fork my-feature-branch
123+
```
124+
125+
#### Make a Pull Request
126+
127+
Go to your fork [https://github.com/[CONTRIBUTOR]/cloudinary-vue](#fork-the-project) and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
128+
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
129+
130+
#### Check on Your Pull Request
131+
132+
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
133+
134+
#### Be Patient
135+
136+
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
137+
138+
#### Thank You
139+
140+
Please do know that we really appreciate and value your time and work. We love you, really.

‎README.md

Lines changed: 4 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ For example:
164164
</cld-image>
165165
```
166166

167+
## How to contribute?
168+
169+
See [contributing guidelines](/CONTRIBUTING.md) in a separate file.
170+
167171
## Additional resources
168172

169173
Additional resources are available at:
@@ -190,45 +194,3 @@ Impact the product, hear updates, test drive new features and more! Join [here](
190194
## License
191195

192196
Released under the MIT license.
193-
194-
## Development
195-
196-
### Installation
197-
198-
```
199-
// in repository folder
200-
npm i -g @vue/cli
201-
npm i
202-
```
203-
204-
### Compile and minify for production
205-
206-
```
207-
npm run build
208-
```
209-
210-
### Documentation
211-
212-
#### Run local styleguidist server
213-
214-
```
215-
npm run styleguide
216-
```
217-
218-
#### Build styleguidist output
219-
220-
```
221-
npm run build:styleguide
222-
```
223-
224-
### Lint files
225-
226-
```
227-
npm run lint
228-
```
229-
230-
### Run all tests
231-
232-
```
233-
npm t
234-
```

0 commit comments

Comments
 (0)