forked from Piraterna/aurix
Initial import
This commit is contained in:
commit
94aad4b8e1
77 changed files with 4414 additions and 0 deletions
46
docs/CONTRIBUTING.md
Normal file
46
docs/CONTRIBUTING.md
Normal file
|
@ -0,0 +1,46 @@
|
|||
# Contributing
|
||||
|
||||
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
|
||||
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
|
||||
|
||||
## Development environment setup
|
||||
|
||||
To set up a development environment, follow these steps:
|
||||
|
||||
1. Clone the repo
|
||||
|
||||
```sh
|
||||
git clone https://github.com/aurixos/os
|
||||
```
|
||||
|
||||
2. Install all required packages
|
||||
|
||||
```sh
|
||||
brew bundle
|
||||
```
|
||||
|
||||
If you don't have Homebrew installed, or don't want to download all optional packages, look at the [Brewfile](../Brewfile) and install all packages manually.
|
||||
|
||||
## Issues and feature requests
|
||||
|
||||
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/aurixos/os/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!
|
||||
|
||||
Please try to create bug reports that are:
|
||||
|
||||
- _Reproducible._ Include steps to reproduce the problem.
|
||||
- _Specific._ Include as much detail as possible: which version, what environment, etc.
|
||||
- _Unique._ Do not duplicate existing opened issues.
|
||||
- _Scoped to a Single Bug._ One bug per report.
|
||||
|
||||
**Even better: Submit a pull request with a fix or new feature!**
|
||||
|
||||
### How to submit a Pull Request
|
||||
|
||||
1. Search our repository for open or closed
|
||||
[Pull Requests](https://github.com/aurixos/os/pulls)
|
||||
that relate to your submission. You don't want to duplicate effort.
|
||||
2. Fork the project
|
||||
3. Create your feature branch (`git checkout -b feat/amazing_feature`)
|
||||
4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) AurixOS uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.
|
||||
5. Push to the branch (`git push origin feat/amazing_feature`)
|
||||
6. [Open a Pull Request](https://github.com/aurixos/os/compare?expand=1)
|
Loading…
Add table
Add a link
Reference in a new issue