Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [claypulse, shellishack]
32 changes: 32 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Pulse Editor Code of Conduct

Like the technical community as a whole, the Pulse Editor team and community is made up of a mixture of professionals and volunteers from all over the world, working on every aspect of the mission - including mentorship, teaching, and connecting people.

Diversity is one of our huge strengths, but it can also lead to communication issues and unhappiness. To that end, we have a few ground rules that we ask people to adhere to. This code applies equally to founders, mentors and those seeking help and guidance.

This isn’t an exhaustive list of things that you can’t do. Rather, take it in the spirit in which it’s intended - a guide to make it easier to enrich all of us and the technical communities in which we participate.

This code of conduct applies to all spaces managed by the Pulse Editor project or ClayPulse AI. This includes IRC, the mailing lists, the issue tracker, DSF events, and any other forums created by the project team which the community uses for communication. In addition, violations of this code outside these spaces may affect a person's ability to participate within them.

If you believe someone is violating the code of conduct, we ask that you report it by emailing [[email protected]](mailto:[email protected]). For more details please see our [Reporting guidelines](https://pulse-editor.com/reporting)

- **Be friendly and patient.**
- **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
- **Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.
- **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the Pulse Editor community should be respectful when dealing with other members as well as with people outside the Pulse Editor community.
- **Be careful in the words that you choose.** We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to:
- Violent threats or language directed against another person.
- Discriminatory jokes and language.
- Posting sexually explicit or violent material.
- Posting (or threatening to post) other people's personally identifying information ("doxing").
- Personal insults, especially those using racist or sexist terms.
- Unwelcome sexual attention.
- Advocating for, or encouraging, any of the above behavior.
- Repeated harassment of others. In general, if someone asks you to stop, then stop.
- **When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time and Pulse Editor is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of Pulse Editor comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.

Original text courtesy of the [Speak Up! project](http://web.archive.org/web/20141109123859/http://speakup.io/coc.html).

## Questions?

If you have questions, please see [Faq](https://pulse-editor.com/faq). If that doesn't answer your questions, feel free to [contact us](mailto:[email protected]) or join our [Discord](https://discord.com/invite/s6J54HFxQp).
82 changes: 82 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Contributing to Pulse Editor 💡

Thank you for your interest in contributing to **Pulse Editor**! We’re building an AI‑powered, cross‑platform editor, and your help is invaluable—whether you're reporting bugs, requesting features, creating your own extensions, or improving docs or code. Let's build something amazing together!

# How to Contribute 🛠

## Reporting Bugs

1. Search existing issues to avoid duplication.

2. Open a new issue with:

- A clear title

- Description of the bug

- Reproduction steps

- Expected vs actual behavior

- Your environment (platform, version, Node.js, etc.)

Feel free to label it with the issue type (e.g. bug, platform:desktop).

## Requesting Features

Open an issue with:

- A clear feature summary

- Use cases or why it's needed

- If possible, mockups or approach outlines

- Label it appropriately (e.g. enhancement, extension)

## Working on Code

1. Fork the repo and create a feature branch (fix/…, feat/…, etc.).

2. Install dependencies and set up your dev environment.

3. Write code, documentation, and tests.

## Opening a Pull Request

1. Target the main or beta branch as appropriate.

2. PR checklist:

- [ ] Includes meaningful title and description

- [ ] References issue (#1234)

- [ ] Includes tests or updated docs

- [ ] Follows code style and passes formatting/linting

3. CI must pass (lint, test, build).

4. Maintainers will review; you may be asked to make changes.

# Code Style & Testing 🔧

Use Prettier & ESLint — run npm run lint and npm run format.

# Communication Channels 💬

- [Issues on GitHub](https://github.com/claypulse/pulse-editor/issues) — bug reports, feature requests, discussion.

- [Discord](https://discord.com/invite/s6J54HFxQp) — for real-time support.

- [Marketplace Developer Program](https://pulse-editor.com/beta) — gain access to publish extensions

# Code of Conduct 🤝

This project is under a [Code of Conduct](/CODE_OF_CONDUCT.md).
Please read it and respect others. Thanks for fostering a welcoming community!

# Acknowledgements 🎉

Thank you to all contributors! Your help in code, tests, docs, issue triage, and more helps make Pulse better every day!