Skip to content

Commit

Permalink
Update contribution guide (#71)
Browse files Browse the repository at this point in the history
* updated read me and contirbution guide

* updated source branch name
  • Loading branch information
cp-divyesh-v authored Dec 23, 2024
1 parent 868ebfe commit bf2a6ae
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 4 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

# Contributing
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.

## Filing issues
When in doubt, file an issue. We'd rather close a few duplicate issues than let a problem go unnoticed.
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.

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.


## Contributing code
We actively welcome your pull requests. You can find instructions on building the project in [README.md](https://github.com/canopas/rich-editor-swiftui).
1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests
4. Make sure your code lints.

## Labels
Labels on issues are managed by contributors, you don't have to worry about them. Here's a list of what they mean:

* **bug**: feature that should work, but doesn't
* **enhancement**: minor tweak/addition to existing behaviour
* **feature**: new behaviour, bigger than enhancement
* **question**: no need of any fix, usually a usage problem
* **reproducible**: has enough information to very easily reproduce, mostly in the form of a small project in a GitHub repo
* **repro-needed**: we need some code to be able to reproduce and debug locally, otherwise there's not much we can do
* **duplicate**: there's another issue which already covers/tracks this
* **wontfix**: working as intended, or won't be fixed due to compatibility or other reasons
* **invalid**: there isn't enough information to make a verdict, or unrelated
* **non-library**: issue is not in the core library code, but rather in documentation, samples, build process, releases

## License
By contributing to RichEditorSwiftUI, you agree that your contributions will be licensed under its Apache License, Version 2.0. See LICENSE file for details.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The editor offers the following <b>options</b>:
- [x] Font family
- [x] Background color
- [x] Export with .txt, .rtf, .pdf, .json
- [x] Link

## Screenshots

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

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

## Contribution

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.

# Bugs and Feedback
For bugs, questions, and discussions please use the [Github Issues](https://github.com/canopas/rich-editor-swiftui/issues).

## Contribution
Currently, we are not accepting any contributions.

## Credits
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).

Expand Down

0 comments on commit bf2a6ae

Please sign in to comment.