linux-insides/CONTRIBUTING.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

2015-01-04 18:03:20 +00:00
Contributing
================================================================================
If you want to contribute to [linux-insides](https://github.com/0xAX/linux-insides), please follow these simple rules:
2015-01-04 18:03:20 +00:00
2016-04-01 15:59:52 +00:00
1. Press the fork button:
2015-01-04 18:03:20 +00:00
![fork](https://docs.github.com/assets/images/help/repository/fork_button.jpg)
2015-01-04 18:03:20 +00:00
2016-04-01 15:59:52 +00:00
2. Clone the repository from your account with:
2015-01-04 18:03:20 +00:00
```
git clone git@github.com:your_github_username/linux-insides.git
```
2015-01-04 18:03:20 +00:00
2016-04-01 15:59:52 +00:00
3. Create a new branch with:
2015-01-04 18:03:20 +00:00
```
git checkout -b "linux-bootstrap-1-fix"
```
2016-04-01 15:59:52 +00:00
You can name it however you want.
2015-01-04 18:03:20 +00:00
2015-01-05 07:03:17 +00:00
4. Make your changes.
2016-04-01 15:59:52 +00:00
5. Don't forget to add yourself in `contributors.md`.
6. Commit and push your changes, then make a pull request from Github.
2015-01-04 18:03:20 +00:00
**IMPORTANT**
2016-04-01 15:59:52 +00:00
Please, don't forget to update your fork. While you made your changes, the content of the `master` branch can change because other pull requests were merged and it can create conflicts. This is why you have to rebase on `master` every time before pushing your changes and check that your branch doesn't have any conflicts with `master`.
2015-01-04 18:03:20 +00:00
2015-04-19 19:15:28 +00:00
Thank you.