Skip to content

Commit bf2a6ae

Browse files
authored
Update contribution guide (#71)
* updated read me and contirbution guide * updated source branch name
1 parent 868ebfe commit bf2a6ae

File tree

2 files changed

+39
-4
lines changed

2 files changed

+39
-4
lines changed

CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
# Contributing
3+
Thank you so much for your interest in contributing! All types of contributions are encouraged and valued. The Project Team looks forward to your contributions.
4+
5+
## Filing issues
6+
When in doubt, file an issue. We'd rather close a few duplicate issues than let a problem go unnoticed.
7+
Similarly, if you support a particular feature request, please let us know by commenting on the issue or [subscribing](https://help.github.com/articles/subscribing-to-conversations/) to the issue.
8+
9+
If you are reporting a bug, please help speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project (or gist) that reproduces the problem.
10+
11+
12+
## Contributing code
13+
We actively welcome your pull requests. You can find instructions on building the project in [README.md](https://github.com/canopas/rich-editor-swiftui).
14+
1. Fork the repo and create your branch from `main`.
15+
2. If you've added code that should be tested, add tests
16+
4. Make sure your code lints.
17+
18+
## Labels
19+
Labels on issues are managed by contributors, you don't have to worry about them. Here's a list of what they mean:
20+
21+
* **bug**: feature that should work, but doesn't
22+
* **enhancement**: minor tweak/addition to existing behaviour
23+
* **feature**: new behaviour, bigger than enhancement
24+
* **question**: no need of any fix, usually a usage problem
25+
* **reproducible**: has enough information to very easily reproduce, mostly in the form of a small project in a GitHub repo
26+
* **repro-needed**: we need some code to be able to reproduce and debug locally, otherwise there's not much we can do
27+
* **duplicate**: there's another issue which already covers/tracks this
28+
* **wontfix**: working as intended, or won't be fixed due to compatibility or other reasons
29+
* **invalid**: there isn't enough information to make a verdict, or unrelated
30+
* **non-library**: issue is not in the core library code, but rather in documentation, samples, build process, releases
31+
32+
## License
33+
By contributing to RichEditorSwiftUI, you agree that your contributions will be licensed under its Apache License, Version 2.0. See LICENSE file for details.

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The editor offers the following <b>options</b>:
2424
- [x] Font family
2525
- [x] Background color
2626
- [x] Export with .txt, .rtf, .pdf, .json
27+
- [x] Link
2728

2829
## Screenshots
2930

@@ -73,7 +74,7 @@ The editor offers the following <b>options</b>:
7374
<video src="https://github.com/user-attachments/assets/844d8843-41e9-44c2-8a0c-afedaa55c5cb" width="90%"/>
7475
</div>
7576

76-
## Editor video
77+
## iPhone Editor video
7778
<div align="center">
7879
<video src="https://github.com/user-attachments/assets/f99804fb-8612-4e46-b172-66567d1acf91" width="90%"/>
7980
</div>
@@ -160,12 +161,13 @@ RichEditorSwiftUI utilizes the latest Apple technologies and adheres to industry
160161
- Swift
161162
- Xcode
162163

164+
## Contribution
165+
166+
The Canopas team enthusiastically welcomes contributions and project participation! There are a bunch of things you can do if you want to contribute! The [Contributor Guide](CONTRIBUTING.md) has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.
167+
163168
# Bugs and Feedback
164169
For bugs, questions, and discussions please use the [Github Issues](https://github.com/canopas/rich-editor-swiftui/issues).
165170

166-
## Contribution
167-
Currently, we are not accepting any contributions.
168-
169171
## Credits
170172
RichEditor for SwiftUI is owned and maintained by the [Canopas team](https://canopas.com/). For project updates and releases, you can follow them on X at [@canopas_eng](https://x.com/canopas_eng).
171173

0 commit comments

Comments
 (0)