Update readmes for newbies
This commit is contained in:
vas3k
parent
b14e427a5b
commit
ca06587c23
|
|
@ -34,20 +34,20 @@ We also run the public [Github Project Board](https://github.com/vas3k/vas3k.clu
|
|||
|
||||
### 🚦Pay attention to issue labels classification
|
||||
|
||||
#### 🟩 Ready to implement
|
||||
##### 🟩 Ready to implement
|
||||
|
||||
- **good first issue** — good tickets **for first-timers**. Usually these are simple and not critical things that allow you to quickly feel the code and start contributing to it.
|
||||
- **bug** — the **first priority**, obviously.
|
||||
|
||||
- **improvement** — accepted improvements for an existing module. Like adding a sort parameter to the feed. If improvement requires UI, **be sure to provide a sketch before you start.**
|
||||
|
||||
#### 🟨 Discussion is needed
|
||||
##### 🟨 Discussion is needed
|
||||
|
||||
- **new feature** — completely new features. Usually they're too hard for newbies, leave them **for experienced contributors.**
|
||||
|
||||
- **idea** — **discussion is needed**. Those tickets look adequate, but waiting for real proposals how they will be done. Don't implement them right away.
|
||||
|
||||
#### 🟥 Questionable
|
||||
##### 🟥 Questionable
|
||||
|
||||
- [¯\\_(ツ)_/¯](https://github.com/vas3k/vas3k.club/labels/ ̄\_(ツ)_%2F ̄) - special label for **questionable issues**. (should be closed in 60 days of inactivity)
|
||||
|
||||
|
|
|
|||
27
README.md
27
README.md
|
|
@ -10,7 +10,7 @@ Welcome to the [vas3k.club](https://vas3k.club) codebase. Here we are building o
|
|||
|
||||
Our values: honesty, fair share, respect for other members, rationality, friendliness and usefulness. We have a zero-tolerance policy on anonymity, insults and toxicity. But we always try to stay in touch with reality, so we're also not tolerant of witch hunting and call-out culture.
|
||||
|
||||
We're bullshitless community!
|
||||
We're a bullshitless community!
|
||||
|
||||
## 🛠 Tech stack
|
||||
|
||||
|
|
@ -39,26 +39,29 @@ We try to keep our stack as simple and stupid as possible. Because we're not ver
|
|||
|
||||
It will start the development server with all the necessary services. Wait till it starts and go to [http://127.0.0.1:8000/](http://127.0.0.1:8000/). Voila.
|
||||
|
||||
At the very beginning, you probably need a dev account to log in. Open [http://127.0.0.1:8000/godmode/dev_login/](http://127.0.0.1:8000/godmode/dev_login/) in your browser and it will create one for you and log you in.
|
||||
- To create new test user: open [http://127.0.0.1:8000/godmode/random_login/](http://127.0.0.1:8000/godmode/random_login/)
|
||||
At the very beginning, you probably need a dev account to log in. Open [/godmode/dev_login/](http://127.0.0.1:8000/godmode/dev_login/) in your browser and it will make one for you (and log you in automatically). To create new test user hit the [/godmode/random_login/](http://127.0.0.1:8000/godmode/random_login/) endpoint.
|
||||
|
||||
Auto-reloading for backend and frontend is performed automatically on every code change. If everything is broken and not working (it happens), you can always rebuild the world from scratch using `docker-compose up --build`.
|
||||
|
||||
## 🧑💻 Advanced setup for developers
|
||||
|
||||
See [docs/setup.md](docs/setup.md)
|
||||
For more information on how to test the telegram bot, run project without docker and other useful notes, read [docs/setup.md](docs/setup.md).
|
||||
|
||||
## ☄️ Testing
|
||||
|
||||
We use standard Django testing framework.
|
||||
We use standard Django testing framework. No magic, really. You can run them from PyCharm or using Django CLI.
|
||||
|
||||
See [docs/test.md](docs/test.md)
|
||||
See [docs/test.md](docs/test.md) for more insights.
|
||||
|
||||
> We don't have UI tests, sorry. Maybe in the future
|
||||
|
||||
## 🚢 Deployment
|
||||
|
||||
CI/CD has setuped via github-actions. Go further to the [.github](.github/) folder to see details.
|
||||
Automatic CI/CD pipelines are building and testing the app on each PR. They also deploy changes to production on merge to master (only a maintainer can do it).
|
||||
|
||||
:point_up: We still need someone who will improve and optimize ci workflows
|
||||
These pipelines are made as github-actions. Explore the [.github](.github) folder for more.
|
||||
|
||||
:point_up: We still need someone to improve and optimize our CI workflows. They work but they're really poor :D
|
||||
|
||||
|
||||
## 😍 Contributions
|
||||
|
|
@ -91,24 +94,24 @@ We also run the public [Github Project Board](https://github.com/vas3k/vas3k.clu
|
|||
- Open our [Issues page](https://github.com/vas3k/vas3k.club/issues) to see the most important tickets at top.
|
||||
- Pick one issue you like and **leave a comment** inside that you're getting it.
|
||||
|
||||
- **For big changes** open an issues first or (if it's already opened) leave a comment with brief explanation what and why you're going to change. Many tickets hang open not because they cannot be done, but because they cause many logical contradictions that you may not know. It's better to clarify them in comments before sending a PR.
|
||||
**For big changes** open an issues first or (if it's already opened) leave a comment with brief explanation what and why you're going to change. Many tickets hang open not because they cannot be done, but because they cause many logical contradictions that you may not know. It's better to clarify them in comments before sending a PR.
|
||||
|
||||
### 🚦Pay attention to issue labels classification
|
||||
|
||||
#### 🟩 Ready to implement
|
||||
##### 🟩 Ready to implement
|
||||
|
||||
- **good first issue** — good tickets **for first-timers**. Usually these are simple and not critical things that allow you to quickly feel the code and start contributing to it.
|
||||
- **bug** — the **first priority**, obviously.
|
||||
|
||||
- **improvement** — accepted improvements for an existing module. Like adding a sort parameter to the feed. If improvement requires UI, **be sure to provide a sketch before you start.**
|
||||
|
||||
#### 🟨 Discussion is needed
|
||||
##### 🟨 Discussion is needed
|
||||
|
||||
- **new feature** — completely new features. Usually they're too hard for newbies, leave them **for experienced contributors.**
|
||||
|
||||
- **idea** — **discussion is needed**. Those tickets look adequate, but waiting for real proposals how they will be done. Don't implement them right away.
|
||||
|
||||
#### 🟥 Questionable
|
||||
##### 🟥 Questionable
|
||||
|
||||
- [¯\\_(ツ)_/¯](https://github.com/vas3k/vas3k.club/labels/ ̄\_(ツ)_%2F ̄) - special label for **questionable issues**. (should be closed in 60 days of inactivity)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue