-
Notifications
You must be signed in to change notification settings - Fork 2
Home
This wiki is designed for old and new contributors and Cursif developers, that wish to learn everything necessary to easily install and contribute to Cursif. It includes a guide on how to get started with Cursif, the API documentation, and more (to come).
⚠️ Cursif officially support Linux, and MacOS only. Although it should work on Windows, it could have unexpected behavior or errors. Consequentially, this guide has been constructed around Linux (Ubuntu), and MacOS.Note that this wiki is still under development and might not contain all the information you need. You can always communicate with us via Discord if you have any questions
We welcome every contribution, small 🦔 or big 🐳.
Whenever you commit to a project's default branch [main] or the gh-pages branch, open an issue, or propose a Pull Request, we'll count that as a contribution
Thus you can contribute by
- Proposing a new feature by opening an issue
- Reporting a bug by opening an issue
- Adding or improving a feature
- Fixing a bug, typo, etc
According to GitHub explaining a contribution, we think you have contributed to the development of Cursif's backend if you did any of those. That being said, there’s a small difference in recognition of contributions. Only someone whose Pull Request has been accepted and merged on the main branch will be displayed on the repository contributor list.
Create a new issue
If you find a problem with the documentation or the bot, search if an issue already exists, if no issue has been created for the problem, you can open a new issue. Be sure to select the appropriate templates.
Solve an issue
If you’d like to solve an issue, go through our issues and select the one that you’d like to solve. You can filter them by using the labels. When you find an issue you’d like to work on, be sure there’s no one assigned to it and that it’s not labeled not ready or wontfix.
When you're finished with the changes, create a pull request, also known as a PR.
- Label your PR as
ready for review - Be sure to link the issue if your PR is related to one.
Change may be required by the team before merging. If it’s the case, suggestions or comments will be given directly on the PR. It will also be labeled change needed.
- Resolve each conversation before asking for a new review.
- When ready, change the label to
ready for reviewand click on Ask re-request review.
Test your changes as much as possible with all use cases before creating a pull request. If you doubt some aspect of your changes (code, visual aspect, etc), don’t hesitate to discuss it or ask for help on the server.
Here are a few helpful tutorials to get started with Git, GitHub, and contributions: