hacktoberfest-2018/CONTRIBUTING.md

37 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2018-09-07 12:23:21 +00:00
# Contributing
2018-09-12 09:25:15 +00:00
## 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.
2018-10-02 15:49:28 +00:00
That said, suggested ways to contribute include:
2018-09-12 09:25:15 +00:00
### Your name on the readme.md
* Fork the project.
2018-10-01 12:54:00 +00:00
* 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)
```
2018-09-12 09:25:15 +00:00
* 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
2018-09-07 12:23:21 +00:00
* Fork the project.
2018-09-12 09:25:15 +00:00
* Make your change.
* Commit and send a pull request. Bonus points for correctly named branches.
2018-09-07 12:23:21 +00:00
## 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.