Skip to content

Latest commit

 

History

History
executable file
·
35 lines (24 loc) · 3.02 KB

CONTRIBUTING.org

File metadata and controls

executable file
·
35 lines (24 loc) · 3.02 KB
Raw

Introduction

Nice to meet you 😄.

Wherever we end up going from here:

Thank you for spending your precious time and valued brainpower—it is truly appreciated!

This contribution guide exists so that you and other contributor will get the most out of your effort for the least time and expenditure required. It is simple—we are looking for all and everything you view as a contribution.

Areas To Contribute

  • Improving documentation.
  • Bug triage.
  • Writing tutorials.
  • Feature ideas.
  • “Simple things” like spelling and grammar fixes, typo correction, white space and formatting changes, and comment clean.
  • Refactoring.
  • Support questions… Yes really! If you are facing it then you can’t be the only one. It is an opportunity to better the documentation, the package itself, or more.
  • Whatever things that aren’t listed here that should be.

Contribution Expectations

Coding style and conventions
The Emacs Lisp code should follow the Emacs Lisp conventions and the Emacs Lisp Style Guide.
Grammar and Language
Use a spell-checker like Aspell and grammar-checker like LanguageTool for your docstrings and documentation. Find writing problems like weasel-words, passive-voice and duplicate words with Writegood Mode. The best tool available today is Grammarly and I recommend it above everything else out there. Given the nature of the global community contributing along with the limited resources in terms of time and energy that we all face: a tool like Grammarly is one of the best investments that you can make both in and outside of the tech world.
Use quality-checking tools
Use flycheck, package-lint and flycheck-package to help you identify common errors in package metadata and code. Use checkdoc to make sure that your package follows the conventions for documentation strings.
Review existing issues
The issue tracker may already have them solved, otherwise they are a great place to start
The Future
The future file may already have new features listed, and if it doesn’t then maybe it should. Either way it might be a great place to start.
Accept the license
Org2Blog is licensed GPLv3: you understand and submit your code under those terms.

Conclusion

That is it. That is everything. If you made it this far then kudos for you to sticking around. Thank you for spending your time here. Hope you keep blogging and having fun with Org2Blog.

Thanks and have a great day.