Merge pull request #84 from HelloYeew/update-readme

Update readme and write a contributor guideline

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing Guidelines
+
+Thank you for showing interest in the development of Rūrusetto. This guidelines below is a guidelines. There are not "official rules" or something like that, but following them will help everyone deal with things in the most efficient manner.
+
+## Table of contents
+
+1. [I would like to submit an issue!](#i-would-like-to-submit-an-issue)
+2. [I would like to submit a pull request!](#i-would-like-to-submit-a-pull-request)
+
+## I would like to submit an issue!
+
+Bug reports and feature suggestion are welcomed!
+
+* **When submitting a bug report, please try to include as much detail as possible**
+
+  To make the bug that you found fix correctly please try to follow the bug report template and try to explain it (How to reproduce, bug behavior etc.) as much as you can.
+
+* **Provide more information when asked to do so.**
+
+  If the bug is complicate or hard to fix. In this case we will likely ask you for additional info. Your additional info can make us track down the problem better.
+
+## I would like to submit a pull request!
+
+We also welcome pull request. The [issue tracker](https://github.com/Rurusetto/rurusetto/issues) should provide an issue from the user and some function that want to implement. Before we go longer, here is some key things before getting started:
+
+* **Make sure you are comfortable with our library and your development environment.**
+
+  This website use Django and Python as backend and HTML, Bootstrap and JavaScript as a frontend. Please make sure that you are familiar with this library and its tool.
+
+  If you contribute to the codebase for the first time and want to learn on the codebase. The issues that tag with [good first issues](https://github.com/Rurusetto/rurusetto/labels/good%20first%20issue) is the best way to contribute with learning the structure the codebase at the same time. 
+
+* **Code quality is the priority for us**
+
+  We have `CodeFactor` to analyze the code quality and the code format. If `CodeFactor` or the maintainer need you to fix the code quality please fix it. We want to make the codebase clean as mush as we can.
+
+* **Make sure that the pull request is complete before opening it.**
+
+  Draft are an option but please check and make sure that you are finish the bug fix or new function before make a new pull request and let the maintainer know and review it.
+
+* **Only push code when it's ready.**
+
+  When pushing to already-open pull request please try to only push changes you are reasonably certain of. Push evert commit will make the continuous integration build queue grow in size, slowing down work and taking time that could be spent to verifying other changes.
+
+* **Make sure to keep the *Allow edits from maintainers* check box checked.**
+
+  To speed up the merging process, sometimes collaborators want to push some change to your pull request. So, having the *Allow edits from maintainers* checkbox checked lets maintainers do that; without it maintainers are forced to report issues back to you and wait for you to address them.
+
+* **Refrain from continually merging the main branch back to the pull request.**
+
+  Please refrain from continually merging the `main` branch unless there are merge conflicts that need resolution. One of the maintainers will merge `main` branch themselves before merging the pull request itself anyway.
+
+* **Refrain from force-pushing to the pull request.**
+
+  Force-pushing should be avoided, as it can lead to accidentally overwriteing a maintainer's changes. The case in which force-pushing is warranted are very rare (such as accidentally leaking sensitive info in one of the files committed, adding unrelated files, or mis-merging a dependent pull request).
+
+* **Refrain from making changes through the GitHub web interface.**
+
+  Even GitHub provide an option to edit code or replace files in the repository using the web interface. Ee strongly discourage using it in most scenarios. Editing files this way is inefficient and likely to introduce whitespace or file encoding changes that make it more difficult to review the code.
+
+  Code written in web interface will also very likely be questioned by the reviewer or fail the continuous integration and code quality check. We strongly encourage using an IDE like [PyCharm](https://www.jetbrains.com/pycharm/) or [Visual Studio Code](https://code.visualstudio.com/).
+
+* **Feel free to reach us for help.**
+
+  If you have any problem on the development process please leave the comment in your pull request or contact the maintainer in the [Discord development server](https://discord.gg/CQPNADu). We will help you as much as we can.

README.md

@@ -4,6 +4,8 @@
 
 [![Continuous Integration](https://github.com/Rurusetto/rurusetto/actions/workflows/django.yml/badge.svg)](https://github.com/Rurusetto/rurusetto/actions/workflows/django.yml)
 [![CodeFactor](https://www.codefactor.io/repository/github/rurusetto/rurusetto/badge)](https://www.codefactor.io/repository/github/rurusetto/rurusetto)
+[![Website](https://img.shields.io/website?down_color=red&down_message=offline&up_color=dark%20green&up_message=online&url=https%3A%2F%2Fbeta.rulesets.info%2F)](https://beta.rulesets.info)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](code_of_conduct.md)
 [![Discord Shield](https://discordapp.com/api/guilds/700619421466624050/widget.png?style=shield)](https://discord.gg/CQPNADu)
 
 A wiki that contain all osu! rulesets
@@ -28,8 +30,8 @@ About question on new website I already write an explanation on [this](https://g
 
 Please make sure you have the following prerequisites:
 
-- [Python](https://www.python.org/)
-- During development on codebase, we recommend IDE with intelligent code completion and syntax highlighting if you work with a codebase. Our recommendation is [PyCharm Professional](https://www.jetbrains.com/pycharm/) or [Visual Studio Code](https://code.visualstudio.com/)
+- [Python 3.7 or better](https://www.python.org/)
+- During development on codebase, we recommend IDE with intelligent code completion and syntax highlighting if you work with a codebase. Our recommendation is [PyCharm](https://www.jetbrains.com/pycharm/) or [Visual Studio Code](https://code.visualstudio.com/)
 - [Git](https://git-scm.com/)
 
 ### Downloading the source code
@@ -90,6 +92,21 @@ cd rurusetto # get in the Rūrusetto project config folder
 python manage.py migrate
 ```
 
+### Fill the configuration value and secret key
+
+Rūrusetto use `python-decouple` library to separate the configuration value and secret key. This library will read the configuration value from `.env` file. Let's create the `.env` file in `rurusetto` folder and below are the template for this file.
+
+```env
+SECRET_KEY = awesome_key_here
+DEBUG = True
+ALLOWED_HOSTS = 127.0.0.1
+OSU_OAUTH_CLIENT_ID = idgohere
+OSU_OAUTH_CLIENT_SECRET = keygohere
+OSU_API_V1_KEY = keygohere
+```
+
+Note : The `OSU_OAUTH_CLIENT_ID` `OSU_OAUTH_CLIENT_SECRET` and `OSU_API_V1_KEY` are required when you want to development with osu! OAuth system or some program part that required the osu! API you must fill the osu! API key and OAuth app number in `settings.py` to start development on this function. But if you are not testing on this function it's okay to leave the key blank. (The development OAuth server callback is http://127.0.0.1:8000/accounts/osu/login/callback/.)
+
 ### Start the development server
 
 Run the `runserver` command in Rūrusetto directory
@@ -99,13 +116,19 @@ cd rurusetto # get in the Rūrusetto project config folder
 python manage.py runserver
 ```
 
-Note : If you want to work on the osu! OAuth system or some program part that required the osu! API you must fill the osu! API key and OAuth app number in `settings.py` to start development on this function. But if you are not testing on this function it's ok to leave the key blank. (The development OAuth server callback is http://127.0.0.1:8000/accounts/osu/login/callback/.)
+## Contributing
+
+When it comes to contributing to the project, the two main things you can do to help out are reporting the issues and submitting pull requests. We have prepared a [list of contributing guidelines](CONTRIBUTING.md) that should hopefully ease you into our collaboration process.
+
+Note that the contributing guidelines is not all. Nothing is set in stone. If you have an issue with the way code is structure, with any libraries we are using, or with any processes involved with contributing, please bring up and ask us! We welcome all feedback, so we can make the contributing to this project as painless as possible.
+
+We use [code of conduct](code_of_conduct.md) from `Contributor Covenant`.
 
 ## License
 
 The code in this repository is licensed under MIT license. Please see [the license file](LICENSE) for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.
 
-The image and the content that upload by user and community is cover on DMCA. If you are the work and owner and want to request to remove your work please email the team at [email protected].
+The image in this website and the content that upload by user and community is cover on DMCA. If you are the work and owner and want to request to remove your work please email the team at [[email protected]](mailto:[email protected]) or contact HelloYeew (project leader) at [[email protected]](mailto:[email protected]).
 
 Each rulesets has its own license.
 

code_of_conduct.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[a team](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations