Skip to content

Commit

Permalink
Add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
cp-sumi-k committed Dec 30, 2024
1 parent f20c1b3 commit 06bc572
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/admin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Deploy Admin-panel
on:
push:
branches:
- main
- master

jobs:
deploy-admin-panel:
Expand Down
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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/canopas-blog-admin).
1. Fork the repo and create your branch from `master`.
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
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ This repository contains the admin panel of [our resources](https://canopas.com/

3. **Automatic previews:** We created custom previews like medium in Blog Editor.Your blog post will have preview of links based on its data like images or videos. You need to just paste the links and it will geneate preview on save and you can see it at your frontend.

4. **CI/CD and Deployment:** With CI in place, every code change is automatically tested and integrated into the main codebase. This ensures that the main branch always remains stable, reducing the chances of bugs and allowing for rapid deployment.
4. **CI/CD and Deployment:** With CI in place, every code change is automatically tested and integrated into the main codebase. This ensures that the master branch always remains stable, reducing the chances of bugs and allowing for rapid deployment.

5. **Recommended Posts:** Enhance user engagement by showcasing recommended posts to your audience. This feature suggests relevant content based on the user's reading history, keeping visitors on your website for longer.

6. **Email Subscription:** Engage your readers effectively with our built-in subscription system. Visitors can subscribe to your blog and receive updates whenever you publish new content, helping you build a loyal readership base. Users can also unsubscribe from emails.
Expand Down Expand Up @@ -119,6 +120,10 @@ The following are main dependencies used by the project

---

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

# Credits

This repository is owned and maintained by the [Canopas team](https://canopas.com/). If you are interested in building web applications, admin panels or designing products, please let us know. We'd love to hear from you!
Expand Down

0 comments on commit 06bc572

Please sign in to comment.