2023-11-19 20:03:10 +00:00
|
|
|
# Contributing to MOROS
|
|
|
|
|
|
|
|
First off, thanks for taking the time to contribute! ❤️
|
|
|
|
|
|
|
|
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 on GitHub ✨
|
|
|
|
- Talk about it on social media
|
|
|
|
- Mention the project at local meetups and tell your friends/colleagues
|
|
|
|
|
|
|
|
## Did you find a bug?
|
|
|
|
|
|
|
|
- Ensure the bug was not already reported by searching on GitHub under
|
2023-11-21 09:01:10 +00:00
|
|
|
[Issues](https://github.com/vinc/moros/issues).
|
2023-11-19 20:03:10 +00:00
|
|
|
- If you're unable to find an open issue addressing the problem,
|
|
|
|
[open a new one](https://github.com/vinc/moros/issues/new). Be sure to
|
|
|
|
include a **title and clear description**, as much relevant information as
|
2023-11-21 09:01:10 +00:00
|
|
|
possible to reproduce it.
|
2023-11-19 20:03:10 +00:00
|
|
|
|
|
|
|
## Did you write a patch that fixes a bug?
|
|
|
|
|
2023-11-21 09:01:10 +00:00
|
|
|
- Open a new GitHub pull request with the patch.
|
|
|
|
- Ensure the PR description clearly describes the problem and solution. Include
|
|
|
|
the relevant issue number if applicable.
|
2023-11-19 20:03:10 +00:00
|
|
|
|
|
|
|
## Do you intend to add a new feature or change an existing one?
|
|
|
|
|
2023-11-21 09:01:10 +00:00
|
|
|
- Suggest your idea by
|
|
|
|
[creating a new discussion](https://github.com/vinc/moros/discussions/new?category=ideas).
|
|
|
|
- Please note that MOROS is a hobby project aimed at developing a simple
|
|
|
|
operating system that can fit in one standard human brain, while also
|
|
|
|
encouraging others to do the same.
|
2023-11-21 09:03:51 +00:00
|
|
|
- You might instead prefer to collaborate on a project with a broader scope such
|
2023-11-21 09:01:10 +00:00
|
|
|
as [Redox](https://www.redox-os.org/) or [Serenity](https://serenityos.org/).
|
2023-11-19 20:03:10 +00:00
|
|
|
|
|
|
|
## Do you have questions about the project?
|
|
|
|
|
2023-11-21 09:01:10 +00:00
|
|
|
- Ask any question about how to use MOROS by
|
|
|
|
[creating a new discussion](https://github.com/vinc/moros/discussions/new?category=q-a).
|