mirror of
https://github.com/Ocelot-Social-Community/ocelot.social.git
synced 2025-12-12 23:35:59 +00:00
alot lint fixes
This commit is contained in:
parent
febbd72779
commit
e48114beb3
GPG Key ID:
DA6B843E748679C9
@ -19,7 +19,7 @@ Examples of unacceptable behavior by participants include:
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Publishing others’ private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
@ -36,7 +36,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devops@ocelot.social. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# CONTRIBUTING
|
||||
|
||||
Thank you so much for thinking of contributing to the [ocelot.social](https://ocelot.social) project! It's awesome you're here, we really appreciate it. :-\)
|
||||
Thank you so much for thinking of contributing to the [ocelot.social](https://ocelot.social) project! It’s awesome you’re here, we really appreciate it. :-\)
|
||||
|
||||
## Getting Set Up
|
||||
|
||||
@ -12,19 +12,19 @@ We also can have pair programming sessions for you! We feel this is often the be
|
||||
|
||||
## Development Flow
|
||||
|
||||
We operate in two week sprints that are planned, estimated and prioritised on [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089). All issues are also linked to and synced with [Github](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues). Look for the `good first issue` label if you're not sure where to start!
|
||||
We operate in two week sprints that are planned, estimated and prioritised on [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089). All issues are also linked to and synced with [Github](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues). Look for the `good first issue` label if you’re not sure where to start!
|
||||
|
||||
We try to discuss all questions directly related to a feature or bug in the respective issue, in order to preserve it for the future and for other developers. We use [Discord](https://discord.gg/AJSX9DCSUA) for real-time communication.
|
||||
|
||||
This is how we solve bugs and implement features, step by step:
|
||||
|
||||
1. We find an issue we want to work on, usually during the sprint planning but as an open source contributor this can happen at any time.
|
||||
2. We communicate with the team to see if the issue is still available. (When you comment on an issue but don't get an answer there within 1-2 days try to mention @Ocelot-Social-Community/core-team to make sure we check in.)
|
||||
1. We find an issue we want to work on, usually during the sprint planning but as an open source contributor this can happen at any time
|
||||
2. We communicate with the team to see if the issue is still available. (When you comment on an issue but don’t get an answer there within 1-2 days try to mention @Ocelot-Social-Community/core-team to make sure we check in.)
|
||||
3. We make sure we understand the issue in detail – what problem is it solving and how should it be implemented?
|
||||
4. We assign ourselves to the issue and move it to `In Progress` on [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089).
|
||||
5. We start working on it in a `new branch` and open a `pull request` prefixed with `[WIP]` (work in progress) to which we regularly push our changes.
|
||||
6. When questions come up we clarify them with the team (directly in the issue on Github).
|
||||
7. When we are happy with our work and our PR is passing all tests we remove the `[WIP]` from the PR description and ask for reviews (if you're not sure who to ask there is @Ocelot-Social-Community/core-team which pings all core developers).
|
||||
4. We assign ourselves to the issue and move it to `In Progress` on [Zenhub](https://app.zenhub.com/workspaces/ocelotsocial-5fb21ff922cb410015dd6535/board?filterLogic=any&repos=301151089)
|
||||
5. We start working on it in a `new branch` and open a `pull request` prefixed with `[WIP]` (work in progress) to which we regularly push our changes
|
||||
6. When questions come up we clarify them with the team (directly in the issue on Github)
|
||||
7. When we are happy with our work and our PR is passing all tests we remove the `[WIP]` from the PR description and ask for reviews (if you’re not sure who to ask there is @Ocelot-Social-Community/core-team which pings all core developers)
|
||||
8. We then incorporate the suggestions from the reviews into our work and once it has been approved it can be merged into master!
|
||||
|
||||
Every pull request needs to:
|
||||
@ -40,7 +40,7 @@ See [contributing in main README.md](/README.md#contributing)
|
||||
|
||||
## The Team
|
||||
|
||||
There are many volunteers all around the world helping us build this network and without their contributions we wouldn't be where we are today. Big thank you to all of you!
|
||||
There are many volunteers all around the world helping us build this network and without their contributions we wouldn’t be where we are today. Big thank you to all of you!
|
||||
|
||||
You can talk to our core team on [Discord](https://discord.gg/AJSX9DCSUA). And on Github you will mostly run into our core developers:
|
||||
|
||||
@ -57,7 +57,7 @@ You can talk to our core team on [Discord](https://discord.gg/AJSX9DCSUA). And o
|
||||
|
||||
## Meetings and Pair Programming Sessions
|
||||
|
||||
Times below refer to **German Time** – that's CET (GMT+1) in winter and CEST (GMT+2) in summer – because most ocelot.social Community core team members are living in Germany.
|
||||
Times below refer to **German Time** – that’s CET (GMT+1) in winter and CEST (GMT+2) in summer – because most ocelot.social Community core team members are living in Germany.
|
||||
|
||||
Daily standup
|
||||
|
||||
@ -107,8 +107,8 @@ Sprint retrospective
|
||||
|
||||
We practice [collective code ownership](http://www.extremeprogramming.org/rules/collective.html) rather than strong code ownership, which means that:
|
||||
|
||||
* developers can make contributions to other people's PRs (after checking in with them)
|
||||
* we avoid blocking because someone else isn't working, so we sometimes take over PRs from other developers
|
||||
* developers can make contributions to other people’s PRs (after checking in with them)
|
||||
* we avoid blocking because someone else isn’t working, so we sometimes take over PRs from other developers
|
||||
* everyone should always push their code to branches so others can see it
|
||||
|
||||
We believe in open source contributions as a learning experience – everyone is welcome to join our team of volunteers and to contribute to the project, no matter their background or level of experience. To support your learning experience we founded the charity association [busFaktor() e.V.](https://www.busfaktor.org/en).
|
||||
@ -185,7 +185,7 @@ Or alternatively use a `YAML` docker compose overwrite file with `platform: linu
|
||||
|
||||
### Analyzing Docker Builds
|
||||
|
||||
To analyze a Docker build, there is a wonderful tool called [dive](https://github.com/wagoodman/dive). Please sponsor if you're using it!
|
||||
To analyze a Docker build, there is a wonderful tool called [dive](https://github.com/wagoodman/dive). Please sponsor if you’re using it!
|
||||
|
||||
The `dive build` command is exactly the right one to fulfill what we are looking for.
|
||||
We can use it just like the `docker build` command and get an analysis afterwards.
|
||||
|
||||
@ -2,17 +2,17 @@
|
||||
|
||||
ocelot.social is free and open-source social network code that connects information to action and promotes positive local and global change in all areas of life.
|
||||
|
||||
* **Social**: Interact with other people not just by commenting their posts, but by providing **Pro & Contra** arguments, give a **Versus** or ask them by integrated **Chat** or **Let's Talk**
|
||||
* **Knowledge**: Read articles about interesting topics and find related posts in the **More Info** tab or by **Filtering** based on **Categories** and **Tagging** or by using the **Fulltext Search**.
|
||||
* **Action**: Don't just read about how to make the world a better place, but come into **Action** by following provided suggestions on the **Action** tab provided by other people or **Organisations**.
|
||||
* **Social**: Interact with other people not just by commenting their posts, but by providing **Pro & Contra** arguments, give a **Versus** or ask them by integrated **Chat** or **Let’s Talk**
|
||||
* **Knowledge**: Read articles about interesting topics and find related posts in the **More Info** tab or by **Filtering** based on **Categories** and **Tagging** or by using the **Fulltext Search**
|
||||
* **Action**: Don’t just read about how to make the world a better place, but come into **Action** by following provided suggestions on the **Action** tab provided by other people or **Organisations**
|
||||
|
||||
## Features
|
||||
|
||||
The following features will be implemented. This gets done in three steps:
|
||||
|
||||
1. First we will implement a basic feature set and provide a test system to test the basic network functionality.
|
||||
2. In a second step we will make our prototype publicly available with an advanced feature set including the technology and organizational structure to drive a bigger public social network.
|
||||
3. In a third step all the remaining features will be implemented to build the full product.
|
||||
1. First we will implement a basic feature set and provide a test system to test the basic network functionality
|
||||
2. In a second step we will make our prototype publicly available with an advanced feature set including the technology and organizational structure to drive a bigger public social network
|
||||
3. In a third step all the remaining features will be implemented to build the full product
|
||||
|
||||
### User Account
|
||||
|
||||
@ -27,7 +27,7 @@ The following features will be implemented. This gets done in three steps:
|
||||
* Change Email Address
|
||||
* Change Password
|
||||
* Delete Account
|
||||
* Download User's Content
|
||||
* Download User’s Content
|
||||
* GDPR-Information about stored Content
|
||||
* Choosing Interface Language \(e.g. German / English / French\)
|
||||
* Persistent Links
|
||||
@ -55,7 +55,7 @@ The following features will be implemented. This gets done in three steps:
|
||||
* Show popular Hashtags Widget
|
||||
* Show Mini-Statistics Widget \(all time\)
|
||||
* Show Chatrooms Widget
|
||||
* Show List of Let's Talk requests with online status of requesting people
|
||||
* Show List of Let’s Talk requests with online status of requesting people
|
||||
|
||||
### Posts
|
||||
|
||||
@ -73,7 +73,7 @@ The following features will be implemented. This gets done in three steps:
|
||||
* Choosing Visibility \(Public / Friends / Private\)
|
||||
* Shout Button for Posts
|
||||
* Bookmark Posts \(later\)
|
||||
* Optionally provide Let's Talk Feature
|
||||
* Optionally provide Let’s Talk Feature
|
||||
* Optionally provide Commenting Feature
|
||||
|
||||
### Comments
|
||||
@ -217,10 +217,10 @@ Shows automatically related actions for existing post.
|
||||
|
||||
* Basic 1:1 Chat functionality
|
||||
|
||||
### Let's Talk
|
||||
### Let’s Talk
|
||||
|
||||
* Request Let's talk with Author of Post
|
||||
* Requestor can request private or public Let's Talk
|
||||
* Request Let’s talk with Author of Post
|
||||
* Requestor can request private or public Let’s Talk
|
||||
* Requestor can choose the Chat format \(Video, Audio, Text\)
|
||||
* Interact with interested People 1:1
|
||||
* Approve request from Requestor
|
||||
@ -253,7 +253,7 @@ Shows automatically related actions for existing post.
|
||||
[Cucumber Features](https://github.com/Ocelot-Social-Community/Ocelot-Social/tree/master/cypress/integration/administration)
|
||||
|
||||
* Provide Admin-Interface to send Users Invite Code
|
||||
* Static Pages for Data Privacy Statement ...
|
||||
* Static Pages for Data Privacy Statement ..
|
||||
* Create, edit and delete Announcements
|
||||
* Pin a post to inform users
|
||||
|
||||
|
||||
@ -53,23 +53,23 @@ Try out our live demo network, see [here](#live-demo-and-developer-logins).
|
||||
|
||||
## Help us
|
||||
|
||||
If you're wondering how you could help, there are plenty of ways, e.g.:
|
||||
If you’re wondering how you could help, there are plenty of ways, e.g.:
|
||||
|
||||
* Spread the good word about ocelot.social to make it more popular:
|
||||
* Add the link [ocelot.social](https://ocelot.social) to your website.
|
||||
* Give ocelot.social a Like at https://alternativeto.net/software/ocelot-social/.
|
||||
* Star our project on GitHub at https://github.com/Ocelot-Social-Community/Ocelot-Social/.
|
||||
* Promote it on your social networks.
|
||||
* Tell your friends about it by word-of-mouth.
|
||||
* Write a press article on ocelot.social or contact the editorial office of your local newspage or radio station.
|
||||
* Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](/CONTRIBUTING.md) first though.
|
||||
* Testing and [reporting](/issues/new/choose) bugs.
|
||||
* Translating: Please [contact us](#contact).
|
||||
* Reviewing and testing pull requests.
|
||||
* Add the link [ocelot.social](https://ocelot.social) to your website
|
||||
* Give ocelot.social a Like at https://alternativeto.net/software/ocelot-social/
|
||||
* Star our project on GitHub at https://github.com/Ocelot-Social-Community/Ocelot-Social/
|
||||
* Promote it on your social networks
|
||||
* Tell your friends about it by word-of-mouth
|
||||
* Write a press article on ocelot.social or contact the editorial office of your local newspage or radio station
|
||||
* Take a [good first issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or issues that need help. Make sure to read [CONTRIBUTING.md](/CONTRIBUTING.md) first though
|
||||
* Testing and [reporting](/issues/new/choose) bugs
|
||||
* Translating: Please [contact us](#contact)
|
||||
* Reviewing and testing pull requests
|
||||
|
||||
## Donate
|
||||
|
||||
Your donation is very welcome and helps to enhance and improve the network. This software is mostly developped and maintained by the association [busFaktor() e.V.](https://www.busfaktor.org/en). Please support us with a [donation](https://www.busfaktor.org/en/donations) to busFaktor() e.V.. Thanks a lot! ❤️
|
||||
Your donation is very welcome and helps to enhance and improve the network. This software is mostly developed and maintained by the association [busFaktor() e.V.](https://www.busfaktor.org/en). Please support us with a [donation](https://www.busfaktor.org/en/donations) to busFaktor() e.V.. Thanks a lot! ❤️
|
||||
|
||||
## Contact
|
||||
|
||||
@ -97,8 +97,8 @@ setup **frontend** and **backend**.
|
||||
|
||||
There are two approaches:
|
||||
|
||||
1. [Local](#local-installation) installation, which means you have to take care of dependencies yourself.
|
||||
2. **Or** Install everything through [Docker](#docker-installation) which takes care of dependencies for you.
|
||||
1. [Local](#local-installation) installation, which means you have to take care of dependencies yourself
|
||||
2. **Or** Install everything through [Docker](#docker-installation) which takes care of dependencies for you
|
||||
|
||||
### Installation
|
||||
|
||||
@ -221,7 +221,7 @@ For a full documentation see [SUMMARY](./SUMMARY.md).
|
||||
Choose an issue (consider our label [good-first-issue](https://github.com/Ocelot-Social-Community/Ocelot-Social/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)) and leave a comment there. We will then invite you to join our volunteers team.
|
||||
To have the necessary permission to push directly to this repository, please accept our invitation to join our volunteers team, you will receive via the email, Github will send you, once invited. If we did not invite you yet, please request an invitation via Discord.
|
||||
|
||||
We are happy if you fork our repository, but we don't recommend it for development. You do not need a fork.
|
||||
We are happy if you fork our repository, but we don’t recommend it for development. You do not need a fork.
|
||||
|
||||
Clone this repository locally as [described above](#clone-the-repository), create your branch named `<issue-number>-<description>`, add your code and push your branch to this repository. Then create a PR by comparing it to our `master`.
|
||||
|
||||
|
||||
@ -62,7 +62,7 @@ If indexes or constraints are missing or not set correctly, the browser search w
|
||||
The indexes and constraints of our database are set in `backend/src/db/migrate/store.js`.
|
||||
This is where the magic happens.
|
||||
|
||||
It's called by our `prod:migrate init` command.
|
||||
It’s called by our `prod:migrate init` command.
|
||||
This command initializes the Admin user and creates all necessary indexes and constraints in the Neo4j database.
|
||||
|
||||
***Calls in development***
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
## Setup with docker
|
||||
|
||||
Are you running everything through docker? You're so lucky you don't have to
|
||||
Are you running everything through docker? You’re so lucky you don’t have to
|
||||
setup anything!
|
||||
|
||||
Just:
|
||||
|
||||
@ -14,7 +14,7 @@ Individual Vue Components should also be documented and tested properly. This gu
|
||||
|
||||
## Unit Testing
|
||||
|
||||
Expecially the Backend relies on Unit Tests, as there are no Vue Components.
|
||||
Especially the Backend relies on Unit Tests, as there are no Vue Components.
|
||||
|
||||
[more...](backend/testing.md)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user