📝 Docs: Add Code of Conduct and Contribution Guide
Just a basic version, will edit as needed.
This commit is contained in:
parent
ff5f340d8c
commit
b7895e0132
GPG key ID:
1DAEFF35ECB5D6DB
3 changed files with 195 additions and 11 deletions
35
CODE_OF_CONDUCT.md
Normal file
35
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Notatio Software Project Code of Conduct
|
||||||
|
|
||||||
|
**1. Purpose:**
|
||||||
|
The Notatio Software project is committed to providing a welcoming and inclusive environment for all contributors. This Code of Conduct outlines our guidelines for interactions within the project, ensuring mutual respect and professionalism.
|
||||||
|
|
||||||
|
**2. Expected Behavior:**
|
||||||
|
|
||||||
|
- Treat all individuals with respect and kindness.
|
||||||
|
- Use clear and constructive communication.
|
||||||
|
- Accept feedback gracefully and be open to learning.
|
||||||
|
- Be considerate of others’ perspectives and experiences.
|
||||||
|
|
||||||
|
**3. Unacceptable Behavior:**
|
||||||
|
Unacceptable behaviors include but are not limited to:
|
||||||
|
|
||||||
|
- Harassment, discrimination, or intimidation in any form.
|
||||||
|
- Offensive, derogatory, or disrespectful language.
|
||||||
|
- Disruptive behavior that hinders the progress of the project.
|
||||||
|
- Personal attacks or trolling.
|
||||||
|
- Any form of unwelcome attention or inappropriate conduct.
|
||||||
|
|
||||||
|
**4. Reporting Violations:**
|
||||||
|
If you observe violations of this Code of Conduct, please report them to the project administrators immediately. All concerns will be reviewed and addressed promptly and confidentially.
|
||||||
|
|
||||||
|
**5. Enforcement:**
|
||||||
|
Violations of this Code of Conduct may result in temporary or permanent exclusion from the project and its associated platforms. The project administrators reserve the right to take appropriate action based on the severity of the offense.
|
||||||
|
|
||||||
|
**6. Scope:**
|
||||||
|
This Code of Conduct applies to all project contributors, including developers, maintainers, users, and participants in project-related activities.
|
||||||
|
|
||||||
|
**7. Acknowledgment:**
|
||||||
|
By participating in the Notatio Software project, you agree to abide by this Code of Conduct. We strive to maintain a positive and collaborative environment where everyone can contribute effectively and feel valued.
|
||||||
|
|
||||||
|
**8. Conclusion:**
|
||||||
|
Thank you for your commitment to upholding these principles. Together, we can create a respectful and productive community within the Notatio Software project.
|
||||||
148
CONTRIBUTING.md
Normal file
148
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,148 @@
|
||||||
|
# Contributing to Notatio
|
||||||
|
|
||||||
|
<!--toc:start-->
|
||||||
|
|
||||||
|
- [Contributing to Notatio](#contributing-to-notatio)
|
||||||
|
- [Table of Contents](#table-of-contents)
|
||||||
|
- [Code of Conduct](#code-of-conduct)
|
||||||
|
- [I Have a Question](#i-have-a-question)
|
||||||
|
- [I Want To Contribute](#i-want-to-contribute)
|
||||||
|
- [Legal Notice](#legal-notice)
|
||||||
|
- [Reporting Bugs](#reporting-bugs)
|
||||||
|
- [Before Submitting a Bug Report](#before-submitting-a-bug-report)
|
||||||
|
- [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
|
||||||
|
- [Suggesting Enhancements](#suggesting-enhancements)
|
||||||
|
- [Before Submitting an Enhancement](#before-submitting-an-enhancement)
|
||||||
|
- [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
|
||||||
|
- [Your First Code Contribution](#your-first-code-contribution)
|
||||||
|
- [Improving The Documentation](#improving-the-documentation)
|
||||||
|
- [Style Guides](#style-guides)
|
||||||
|
- [Commit Messages](#commit-messages)
|
||||||
|
- [Join The Project Team](#join-the-project-team)
|
||||||
|
- [Attribution](#attribution)
|
||||||
|
<!--toc:end-->
|
||||||
|
|
||||||
|
First off, thanks for taking the time to contribute!
|
||||||
|
|
||||||
|
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
|
||||||
|
|
||||||
|
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
|
||||||
|
|
||||||
|
> - Star the project
|
||||||
|
> - Tweet about it
|
||||||
|
> - Refer this project in your project's README
|
||||||
|
> - Mention the project at local meetups and tell your friends/colleagues
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Code of Conduct](#code-of-conduct)
|
||||||
|
- [I Have a Question](#i-have-a-question)
|
||||||
|
- [I Want To Contribute](#i-want-to-contribute)
|
||||||
|
- [Reporting Bugs](#reporting-bugs)
|
||||||
|
- [Suggesting Enhancements](#suggesting-enhancements)
|
||||||
|
- [Your First Code Contribution](#your-first-code-contribution)
|
||||||
|
- [Improving The Documentation](#improving-the-documentation)
|
||||||
|
- [Style guides](#styleguides)
|
||||||
|
- [Commit Messages](#commit-messages)
|
||||||
|
- [Join The Project Team](#join-the-project-team)
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
This project and everyone participating in it is governed by the
|
||||||
|
[Notatio Code of Conduct](/CODE_OF_CONDUCT.md).
|
||||||
|
By participating, you are expected to uphold this code. Please report unacceptable behavior
|
||||||
|
to <>.
|
||||||
|
|
||||||
|
## I Have a Question
|
||||||
|
|
||||||
|
> If you want to ask a question, we assume that you have read the available [Documentation](/wiki).
|
||||||
|
|
||||||
|
Before you ask a question, it is best to search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
|
||||||
|
|
||||||
|
If you then still feel the need to ask a question and need clarification, we recommend the following:
|
||||||
|
|
||||||
|
- Open an [Issue](/issues/new).
|
||||||
|
- Provide as much context as you can about what you're running into.
|
||||||
|
- Provide project and platform versions (NodeJS, NPM, etc.), depending on what seems relevant.
|
||||||
|
|
||||||
|
We will then take care of the issue as soon as possible.
|
||||||
|
|
||||||
|
## I Want To Contribute
|
||||||
|
|
||||||
|
> ### Legal Notice
|
||||||
|
>
|
||||||
|
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. **THIS MEANS NO AI GENERATED CONTENT.**
|
||||||
|
|
||||||
|
### Reporting Bugs
|
||||||
|
|
||||||
|
#### Before Submitting a Bug Report
|
||||||
|
|
||||||
|
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
|
||||||
|
|
||||||
|
- Make sure that you are using the latest version.
|
||||||
|
- Determine if your bug is really a bug and not an error on your side e.g., using incompatible environment components/versions (Make sure that you have read the [documentation](/wiki). If you are looking for support, you might want to check [this section](#i-have-a-question)).
|
||||||
|
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug).
|
||||||
|
- Also make sure to search the internet (including Stack Overflow) to see if users outside the platform have discussed the issue.
|
||||||
|
- Collect information about the bug:
|
||||||
|
- Stack trace (Traceback)
|
||||||
|
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
|
||||||
|
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
|
||||||
|
- Possibly your input and the output
|
||||||
|
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
|
||||||
|
|
||||||
|
#### How Do I Submit a Good Bug Report?
|
||||||
|
|
||||||
|
> You must never report security related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
|
||||||
|
|
||||||
|
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
|
||||||
|
|
||||||
|
- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
|
||||||
|
- Explain the behavior you would expect and the actual behavior.
|
||||||
|
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
|
||||||
|
- Provide the information you collected in the previous section.
|
||||||
|
|
||||||
|
Once it's filed:
|
||||||
|
|
||||||
|
- The project team will label the issue accordingly.
|
||||||
|
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
|
||||||
|
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
|
||||||
|
|
||||||
|
### Suggesting Enhancements
|
||||||
|
|
||||||
|
This section guides you through submitting an enhancement suggestion for Notatio, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
|
||||||
|
|
||||||
|
#### Before Submitting an Enhancement
|
||||||
|
|
||||||
|
- Make sure that you are using the latest version.
|
||||||
|
- Read the [documentation](/wiki) carefully and find out if the functionality is already covered, maybe by an individual configuration.
|
||||||
|
- Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
|
||||||
|
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
|
||||||
|
|
||||||
|
#### How Do I Submit a Good Enhancement Suggestion?
|
||||||
|
|
||||||
|
Enhancement suggestions are tracked as [GitHub issues](/issues).
|
||||||
|
|
||||||
|
- Use a **clear and descriptive title** for the issue to identify the suggestion.
|
||||||
|
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
|
||||||
|
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
|
||||||
|
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
|
||||||
|
- **Explain why this enhancement would be useful** to most Notatio users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
|
||||||
|
|
||||||
|
### Your First Code Contribution
|
||||||
|
|
||||||
|
### Improving The Documentation
|
||||||
|
|
||||||
|
Currently, any improvements would help, but keep in mind that this project is under heavy development and features may change rapidly.
|
||||||
|
This means documentation will need to be updated often to keep up to date.
|
||||||
|
|
||||||
|
## Style Guides
|
||||||
|
|
||||||
|
### Commit Messages
|
||||||
|
|
||||||
|
Please use Sumi and Gitmoji to generate the git commit messages.
|
||||||
|
Hooks are already provided for your convenience.
|
||||||
|
|
||||||
|
## Join The Project Team
|
||||||
|
|
||||||
|
Members will be added as needed by a consensus of the current maintainers.
|
||||||
|
Proposed members need to be an active contributor for at least 3 months (subject to change), and have contributed at least one major feature.
|
||||||
23
README.md
23
README.md
|
|
@ -2,34 +2,35 @@
|
||||||
|
|
||||||
## 💡 About
|
## 💡 About
|
||||||
|
|
||||||
**Notatio is currently under heavy development, and as such there is the possibility breaking changes**
|
**Notatio is currently under heavy development!
|
||||||
|
As such there is the possibility breaking changes**
|
||||||
|
|
||||||
Notatio is a self-hostable, containerized, web-based text editor. The main objective of the project is to create a platform independent text editor (and productivity management suite). I hope to develop this as an alternative to proprietary software like obsidian and Notion.so which I have loved and used in the past. This software was originally created as part of a Senior Capstone, but is now being developed in my spare time while job hunting.
|
Notatio is a self-hostable, containerized, web-based text editor.
|
||||||
|
The main objective of the project is to create a platform independent text editor (and productivity management suite).
|
||||||
|
I hope to develop this as an alternative to proprietary software like obsidian and Notion.so which I have loved and used in the past.
|
||||||
|
This software was originally created as part of a Senior Capstone, but is now being developed in my spare time while job hunting.
|
||||||
|
|
||||||
## 🛣️ **Roadmap**
|
## 🛣️ **Roadmap**
|
||||||
|
|
||||||
#### In Progress
|
### In Progress
|
||||||
|
|
||||||
- 🕓 Building Custom Text Editor
|
- 🕓 Building Custom Text Editor
|
||||||
- 🕓 Add Kanban Board
|
- 🕓 Add Kanban Board
|
||||||
|
|
||||||
|
### Planned V1 Release
|
||||||
#### Planned V1 Release
|
|
||||||
|
|
||||||
- [ ] Flesh out File Management Operations
|
- [ ] Flesh out File Management Operations
|
||||||
- [ ] NoSQL setup option
|
- [ ] NoSQL setup option
|
||||||
|
|
||||||
#### Planned v1.1 Release
|
### Planned v1.1 Release
|
||||||
|
|
||||||
- [ ] Collaborative Editing
|
- [ ] Collaborative Editing
|
||||||
- [ ] File Versioning
|
- [ ] File Versioning
|
||||||
|
|
||||||
#### Planned v1.2 Release
|
### Planned v1.2 Release
|
||||||
|
|
||||||
- [ ] End-to-End Encryption
|
- [ ] End-to-End Encryption
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 💾 **Download**
|
## 💾 **Download**
|
||||||
|
|
||||||
Downloading Notatio is simple! Just clone the repository using the command below:
|
Downloading Notatio is simple! Just clone the repository using the command below:
|
||||||
|
|
@ -42,7 +43,7 @@ git clone https://codeberg.org/musselman/notatio
|
||||||
|
|
||||||
There are two ways to run Notatio.
|
There are two ways to run Notatio.
|
||||||
|
|
||||||
### 📦 Container (Recommended)**
|
### 📦 Container (Recommended)\*\*
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -98,4 +99,4 @@ As this is no longer an academic project, All contributions are welcome. Please
|
||||||
|
|
||||||
## 📄 License
|
## 📄 License
|
||||||
|
|
||||||
This project is licensed under the AGPL - see the [LICENSE](./LICENSE) file for details
|
This project is licensed under the AGPL – see the [LICENSE](./LICENSE) file for details
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue