mirror of
https://github.com/c0de-archive/hacktoberfest-2018.git
synced 2024-11-01 04:07:48 +00:00
37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
# Contributing
|
|
|
|
## How to Contribute
|
|
|
|
This repository is built for the purpose of encouraging your contributions, big or small. **All** changes are considered, as long as they do not complicate the process for others.
|
|
|
|
That said, suggested ways to contribute include:
|
|
|
|
### Your name on the readme.md
|
|
|
|
* Fork the project.
|
|
* Add your name to the readme.md using this example;
|
|
```
|
|
### My Name
|
|
- Description about me
|
|
- [![twitter-alt][twitter-img]](https://twitter.com/example)
|
|
[![github-alt][github-img]](https://github.com/example)
|
|
```
|
|
* Commit and send a pull request. Bonus points for correctly named branches.
|
|
|
|
### A code sample
|
|
|
|
* Fork the project.
|
|
* Create a code sample under `/code` named <yourname>.<language-file-extension>. I.e. `lukeoliff.js`, `lukeoliff.php`
|
|
* Create a working hello world example inside your file.
|
|
* Commit and send a pull request. Bonus points for correctly named branches.
|
|
|
|
### Anything else
|
|
|
|
* Fork the project.
|
|
* Make your change.
|
|
* Commit and send a pull request. Bonus points for correctly named branches.
|
|
|
|
## Code of Conduct
|
|
|
|
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
|