mirror of
https://github.com/JuanCanham/HackMyResume.git
synced 2024-11-05 01:56:21 +00:00
59 lines
2.1 KiB
Markdown
59 lines
2.1 KiB
Markdown
|
Contributing
|
||
|
|
============
|
||
|
|
|
||
|
|
*Note: HackMyResume is also available as [FluentCV][fcv]. Contributors are
|
||
|
|
credited in both.*
|
||
|
|
|
||
|
|
HackMyResume needs your help! Our contribution workflow is based on [GitHub
|
||
|
|
Flow][flow] and we respond to all pull requests and issues, usually within 24
|
||
|
|
hours. HackMyResume has no corporate affiliation and no commercial basis, which
|
||
|
|
allows the project to maintain a strict user-first policy, rapid development
|
||
|
|
velocity, and a liberal stance on contributions and exotic functionality in
|
||
|
|
keeping with the spirit (and name) of the tool.
|
||
|
|
|
||
|
|
In short, your code is welcome here.
|
||
|
|
|
||
|
|
## How To Contribute
|
||
|
|
|
||
|
|
1. Optional: [**open an issue**][iss] identifying the feature or bug you'd like
|
||
|
|
to implement or fix. This step isn't required — you can start hacking away on
|
||
|
|
HackMyResume without clearing it with us — but helps avoid duplication of work
|
||
|
|
and ensures that your changes will be accepted once submitted.
|
||
|
|
2. **Fork and clone** the HackMyResume project.
|
||
|
|
3. Ideally, **create a new feature branch** (eg, `feat/new-awesome-feature` or
|
||
|
|
similar; call it whatever you like) to perform your work in.
|
||
|
|
4. **Install dependencies** by running `npm install` in the top-level
|
||
|
|
HackMyResume folder.
|
||
|
|
5. Make your **commits** as usual.
|
||
|
|
6. **Verify** your changes locally with `npm test`.
|
||
|
|
7. **Push** your commits.
|
||
|
|
7. **Submit a pull request** from your feature branch to the HackMyResume `dev`
|
||
|
|
branch.
|
||
|
|
8. We'll typically **respond** within 24 hours.
|
||
|
|
9. Your awesome changes will be **merged** after verification.
|
||
|
|
|
||
|
|
## Project Maintainers
|
||
|
|
|
||
|
|
HackMyResume is currently maintained by [hacksalot][ha] with assistance from
|
||
|
|
[tomheon][th] and our awesome [contributors][awesome]. Please direct all official
|
||
|
|
or internal inquiries to:
|
||
|
|
|
||
|
|
```
|
||
|
|
admin@hackmyresume.com
|
||
|
|
```
|
||
|
|
|
||
|
|
You can reach hacksalot directly at:
|
||
|
|
|
||
|
|
```
|
||
|
|
hacksalot@indevious.com
|
||
|
|
```
|
||
|
|
|
||
|
|
Thanks! See you out there in the trenches.
|
||
|
|
|
||
|
|
[fcv]: https://github.com/fluentdesk/fluentcv
|
||
|
|
[flow]: https://guides.github.com/introduction/flow/
|
||
|
|
[iss]: https://github.com/hacksalot/HackMyResume/issues
|
||
|
|
[ha]: https://github.com/hacksalot
|
||
|
|
[th]: https://github.com/tomheon
|
||
|
|
[awesome]: https://github.com/hacksalot/HackMyResume/graphs/contributors
|