Migrate contributing guide and cod to the doc generator
This commit is contained in:
parent
d5b06146a7
commit
ab977855e2
|
|
@ -0,0 +1,65 @@
|
|||
#+SETUPFILE: ../../config.org
|
||||
#+OPTIONS: toc:nil
|
||||
#+EXPORT_FILE_NAME: code-of-conduct.html
|
||||
#+DATE: 2021-07-01
|
||||
#+TITLE: Contributor Covenant Code of Conduct
|
||||
#+PAGE: true
|
||||
#+DESC: An GNU/Emacs based editor for hackers
|
||||
|
||||
|
||||
** Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers
|
||||
pledge to making participation in our project and our community a harassment-free experience for everyone,
|
||||
regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
** Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
** Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to
|
||||
take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
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, or to ban
|
||||
temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening,
|
||||
offensive, or harmful.
|
||||
|
||||
** Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing
|
||||
the project or its community. Examples of representing a project or community include using an official project
|
||||
e-mail address, posting via an official social media account, or acting as an appointed representative at an
|
||||
online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||
|
||||
** Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project
|
||||
team at devs@codamic.tech. The project team will review and investigate all complaints, and will respond in
|
||||
a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality
|
||||
with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
|
||||
repercussions as determined by other members of the project's leadership.
|
||||
|
||||
** Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [[http://contributor-covenant.org][Contributor Covenant]], version [[http://contributor-covenant.org/version/1/4/][1.4]], available
|
||||
at http://contributor-covenant.org/version/1/4
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
#+SETUPFILE: ../../config.org
|
||||
#+OPTIONS: toc:nil
|
||||
#+EXPORT_FILE_NAME: contributors.html
|
||||
#+DATE: 2021-07-01
|
||||
#+TITLE: Contributors
|
||||
#+PAGE: true
|
||||
#+DESC: An GNU/Emacs based editor for hackers
|
||||
|
||||
People how contributed to *FG42* sorted by their number of contribution at the time
|
||||
of generating the list:
|
||||
- Sameer Rahmani ([[https://twitter.com/lxsameer][@lxsameer]])
|
||||
- Amir Reza Askarpour ([[https://twitter.com/amirrezaask][@amirrezaask]])
|
||||
- Mary Salehi
|
||||
- Amir Hooshangi ([[https://twitter.com/amirhoshangi][@amirhoshangi]])
|
||||
- Behnam Ahmad Khan Beigi ([[https://twitter.com/yottanami][@yottanami]])
|
||||
- Danial Parsi ([[https://twitter.com/intuxticated][@intuxticated]])
|
||||
- Pouya Abbassi
|
||||
- Keyvan Hedayati ([[https://twitter.com/k1-hedayati][@k1-hedayati]])
|
||||
- Nima Nazari ([[https://twitter.com/mandrivan][@mandrivan]])
|
||||
- Pouria
|
||||
- Delaram Sobhani ([[https://twitter.com/DelaRam90][@DelaRam90]])
|
||||
- Ehsan Mahmoudi ([[https://twitter.com/jeyem90][@jeyem90]])
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
#+SETUPFILE: ../../config.org
|
||||
#+OPTIONS: toc:nil
|
||||
#+EXPORT_FILE_NAME: how-to-contribute.html
|
||||
#+DATE: 2021-07-01
|
||||
#+TITLE: How to contribute to FG42
|
||||
#+PAGE: true
|
||||
#+DESC: An GNU/Emacs based editor for hackers
|
||||
|
||||
Wow, thanks for your interest in helping out with FG42. Let this document
|
||||
serve as your guide.
|
||||
|
||||
** Looking for work?
|
||||
|
||||
If you're looking for a task to work on, check out [[https://devheroes.codes/FG42/FG42/src/branch/master/dev.org][the dev]] file. We keepe our
|
||||
big TODOs there. Or reach out to [[https://lxsameer.com][@lxsameer]] to talk about the possiblities.
|
||||
|
||||
** New Features
|
||||
|
||||
FG42 is the thinking persons editor, so for major contribution, start with some *deeeep*
|
||||
thoughts. Finished?
|
||||
|
||||
Alright, your next step is to start a discussion.
|
||||
|
||||
Create an [[https://devheroes.codes/FG42/FG42/issues][issue]] to start a conversation. Tell us what you're trying to accomplish
|
||||
and how you think you might do it. If all is well, we will collaborate on delivering
|
||||
the feature.
|
||||
|
||||
** Bugs
|
||||
|
||||
Of course, if you run into any straight-up bugs or weirdness feel free to skip
|
||||
the thinking (or at least too much of it) and immediately submit an [[https://devheroes.codes/FG42/FG42/issues][issue]].
|
||||
|
||||
We have an issue template in place that will ask you some details
|
||||
about the platform you are running and how to reproduce the bug. (If
|
||||
you can reproduce it reliably. If not, go ahead and file the issue
|
||||
anyway so we can start looking at it.)
|
||||
|
||||
Some of the usual stuff we'll want to know:
|
||||
|
||||
- What happened?
|
||||
"I manifested a being from the outer dimensions."
|
||||
|
||||
- What did you expect to happen?
|
||||
"Hello, world."
|
||||
|
||||
- How can you reprodice it?
|
||||
"I created a new FG42 cube with the template, then installed some code that Bob Howard gave me."
|
||||
|
||||
- What operating system and version are you using?
|
||||
e.g. "Gentoo stable"
|
||||
|
||||
- What version of Emacs are you using?
|
||||
e.g. "Emacs 27.1"
|
||||
|
||||
- What FG42 version are you using?
|
||||
e.g. "3.0.0"
|
||||
|
||||
Even better, include a link to a gist or repository where we can jump straight
|
||||
to the problem.
|
||||
Loading…
Reference in New Issue