- A decent text editor (for text content)
- Basic knowledge of [Markdown] for formatting your content
- A genuine excitement to open source your life and help others do the same
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
I am committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery
- Personal attacks
- Trolling or insulting/derogatory comments
- Public or private harassment
- Publishing other's private information, such as physical or electronic addresses, without explicit permission
- Other unethical or unprofessional conduct.
- Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
This Code of Conduct is adapted from the Contributor Covenant, version 1.2.0
- Fork the book
- Add awesome content or fix an issue
- Add your name (alphabetically) to the Authors & Contributors page
- Submit a pull request
- When merged, a CI job will run and publish the content to Leanpub and then later published to Create Space and Amazon.
You are welcome to send pull requests to me, in fact I encourage it - by doing so you'll be added to the Authors & Contributors page in the book that you are granting me a non-exclusive, non-revokable, no-cost license to use the code, algorithms, patents, ideas and content in that work if I so choose. You also agree the content is provided as-is and you provide no warranties as to its fitness or correctness for any purpose.
Know that as the source owner I am obligated to make sure that the stories and content in the book are consistent and keep the integrity of the book intact. So if you submit a PR and it gets edited or not accepted please look at it just as though you were submitting a PR to any other open source project where the owners have to make sure the code fits the design and architecture.
This project uses GitHub issues to help me sort our and prioritize things that need to get done. If you come across anything in the book that feels "off" and simply don't have time to do a pull request please consider creating an issue!
Most of us know that self publishing authors do not really get paid much at all (if anything) - that is the case and purpose with this book. The intent is to not make money but rather to share and talk about things in our lives that are often avoided and assumed unchangeable. The book is currently published on Leanpub for free (with option to buy), published on Create Space as a printed book and on Amazon as a print and ebook - neither of which can be set to a "free" price.
Know that your contributions will reach and help users but in terms of this book and royalties earned will not be redistributed.