Migrate contributing guide and cod to the doc generator
This commit is contained in:
parent
a77d2ee6c5
commit
d5b06146a7
|
@ -1,61 +0,0 @@
|
||||||
[appendix]
|
|
||||||
= Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
== 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 [Contributor Covenant][homepage], version 1.4, available at http://contributor-covenant.org/version/1/4[version]
|
|
||||||
|
|
||||||
http://contributor-covenant.org[homepage]
|
|
||||||
http://contributor-covenant.org/version/1/4/[version]
|
|
|
@ -1,59 +0,0 @@
|
||||||
[appendix]
|
|
||||||
= Contributing to HellHound
|
|
||||||
|
|
||||||
Wow, thanks for your interest in helping out with HellHound. Let this document
|
|
||||||
serve as your guide.
|
|
||||||
|
|
||||||
== Looking for work?
|
|
||||||
|
|
||||||
If you're looking for a task to work on, check out the
|
|
||||||
http://github.com/Codamic/hellhound/issues?labels=TODO[TODO] in our issues.
|
|
||||||
|
|
||||||
Less defined tasks will be marked with the
|
|
||||||
http://github.com/Codamic/hellhound/issues?labels=discuss[discuss label]. Jump in here if you want to be
|
|
||||||
a part of something big.
|
|
||||||
|
|
||||||
== New Features
|
|
||||||
|
|
||||||
HellHound is the thinking persons framework, so every contribution starts with
|
|
||||||
some *deeeep* thought. Finished?
|
|
||||||
|
|
||||||
Alright, your next step is to start a discussion.
|
|
||||||
|
|
||||||
Create an https://github.com/Codamic/hellhound/issues/new[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'll probably give you the :thumbsup: to
|
|
||||||
start developing.
|
|
||||||
|
|
||||||
== 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://github.com/codamic/hellhound/issues/new[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 HellHound service with the template, then installed some code that Bob Howard gave me."
|
|
||||||
* What operating system and version are you using?
|
|
||||||
** e.g. "OS X 10.8"
|
|
||||||
* What version of Clojure, Java, and Leiningen or Boot are you using?
|
|
||||||
** e.g. "Leiningen 2.5.2 on Java 1.8.0_u40 Java HotSpot(TM) 64-Bit Server VM"
|
|
||||||
* What HellHound version are you using?
|
|
||||||
** e.g. "0.5.0"
|
|
||||||
** or, for a SNAPSHOT: "0.5.1-SNAPSHOT at d0cf2b4"
|
|
||||||
|
|
||||||
Even better, include a link to a gist or repository where we can jump straight
|
|
||||||
to the problem.
|
|
||||||
|
|
||||||
== Tests
|
|
||||||
<PLACEHOLDER TEXT>
|
|
|
@ -1,31 +0,0 @@
|
||||||
== Getting Started
|
|
||||||
In this section i'm going to walk you through the installation process of *FG42* and some basic usage. Also
|
|
||||||
If you already know how to use Emacs you just need the installation subsection of this section.
|
|
||||||
|
|
||||||
=== Installation
|
|
||||||
In order to run *FG42* you need *GNU Emacs >= 25*. FG42 uses several extensions internally
|
|
||||||
which each of the has different external dependencies. To gain more information about external
|
|
||||||
dependencies ( If we failed to tell you inside the **FG42** ) just run the `describe-extension`
|
|
||||||
command. Also I have plans in near future to create some packages for popular gnu/linux distros
|
|
||||||
and MacOS as well, but untill then you have to take care of the external dependencies by yourself.
|
|
||||||
|
|
||||||
In order to install **FG42**, issue the following commands:
|
|
||||||
|
|
||||||
[source,bash,linum]
|
|
||||||
----
|
|
||||||
# clonse the FG42 repository in ~/.fg42 directory
|
|
||||||
git clone git://gitlab.com/FG42/FG42.git ~/.fg42/
|
|
||||||
# You can clone it where ever your want
|
|
||||||
cd ~/.fg42/
|
|
||||||
# You need to be sudoer, the install script will ask for your password.
|
|
||||||
make install
|
|
||||||
----
|
|
||||||
|
|
||||||
Since the installer script uses `sudo`, during the installation process,
|
|
||||||
you'll have to enter your password. Make sure that you're user account has
|
|
||||||
a `sudo` access.
|
|
||||||
|
|
||||||
=== Execution
|
|
||||||
If you installed FG42 using git your installation does not contain any elisp package. So, when for the
|
|
||||||
first time you executes FG42 it detects the missing libraries and download them from Melpa. It might
|
|
||||||
take a while depends on your internet connection.
|
|
Loading…
Reference in New Issue