Skip to content

Commit

Permalink
Add: contributing and changelog fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
teesloane committed Sep 29, 2020
1 parent 4892808 commit 77d896e
Show file tree
Hide file tree
Showing 2 changed files with 163 additions and 1 deletion.
147 changes: 147 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
## Regarding Software and Roadmap

The ethos and intent of Firn is still developing. Contributions are welcome, but
until a more readily available roadmap exists, you may wish to consider opening
an issue or to ask questions in the Discord channel before starting a large
contribution/patch.

With that said, these things come to my mind when I am building Firn.

- Cover the first 75% of the more popular features of org-mode, and cover more
niche features later.
- Stay close to rendering plaintext/html. Avoid JavaScript and Frontend bloat.
- Make it extensible with a small core.

Please keep in mind that I am learning as I build. Refactors to code style
are welcome provided that they are explained and discussed - not solely for
myself, but for others who also want to learn more.

I will try and update the GitHub projects board for providing a basic roadmap
for those interested in contributing.

## Regarding Community

The below is a common template used for contributing guides. I would expect that
those contributing be aware of it and know that I will do my best to foster
a welcoming space while also attempting to build free software.

All things have a start and end. Let's make it nice while we're here.

> Before you speak, let your words pass through three gates:
>
> At the first gate, ask yourself, “Is it true?”
>
> At the second gate ask, “Is it necessary?”
>
> At the third gate ask, “Is it kind?”
### Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community. Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

Demonstrating empathy and kindness toward other people Being respectful of
differing opinions, viewpoints, and experiences Giving and gracefully
accepting constructive feedback Accepting responsibility and apologizing to
those affected by our mistakes, and learning from the experience Focusing on
what is best not just for us as individuals, but for the overall community

### Examples of unacceptable behavior include:

The use of sexualized language or imagery, and sexual attention or advances
of any kind Trolling, insulting or derogatory comments, and personal or
political attacks Public or private harassment Publishing others’ private
information, such as a physical or email address, without their explicit
permission Other conduct which could reasonably be considered inappropriate
in a professional setting

### Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate. Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event. Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected]. Complaints will be reviewed and investigated to the
best of a maintainers ability given the circumstances.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident. Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

1. Correction

Community Impact: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

Consequence: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

2. Warning

Community Impact: A violation through a single incident or series of actions.

Consequence: A warning with consequences for continued behavior. No interaction
with the people involved, including unsolicited interaction with those enforcing
the Code of Conduct, for a specified period of time. This includes avoiding
interactions in community spaces as well as external channels like social media.
Violating these terms may lead to a temporary or permanent ban.

3. Temporary Ban

Community Impact: A serious violation of community standards, including
sustained inappropriate behavior.

Consequence: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

4. Permanent Ban

Community Impact: Demonstrating a pattern of violation of community standards,
including sustained inappropriate behavior, harassment of an individual, or
aggression toward or disparagement of classes of individuals.

Consequence: A permanent ban from any sort of public interaction within the
community.

### Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.0,
available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by Mozilla’s code of conduct
enforcement ladder.

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
17 changes: 16 additions & 1 deletion docs/changelog.org
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#+FIRN_ORDER: 5
#+FIRN_TOC: {:depth 1}
#+FIRN_UNDER: Reference
#+DATE_UPDATED: <2020-09-25 20:00>
#+DATE_UPDATED: <2020-09-28 06:35>
#+DATE_CREATED: <2020-07-05 Wed 17:10>

* V.0.0.9
Expand All @@ -16,13 +16,28 @@
- Add ~(render :org-tags)~
- Ability to use ~render~ in a non-org ~page~ - only global things may be rendered, however, such as a site-map, or a firn/org tags.
- Add ~build-url~ function for easier creation of internal urls.
- Ability to customize where an org-mode ~:tag:~ links to, by default they would link to a "{my-domain}/tags" page. To change this, you must add a key ~:org-tags-path~ to your ~config.edn~.
- Add new function: ~build-url~ to layouts, allowing you to construct root domain urls more easily (for example, linking to a static css file.)
** Breaking Changes
- Custom pages are no longer added to the sitemap; they currently present too
much trouble as they do not have front matter and thus cannot be discerned
where they fit in with possible sorting mechanisms on the site-map (ie, they
cannot have a ~FIRN_ORDER~ value, and thus have to default to being pushed to
999999~ order and so remain at the "bottom" of the sitemap. Still looking for
a better solution to this.)
- In org files, The ~#+FIRN_UNDER~ front matter no longer needs to be a Clojure vector, and can instead just be a plain text, space delimited value (with multiple word values being wrapped in quotes.) Example:

Before:
#+BEGIN_SRC
#+FIRN_UNDER: ["Projects" "Audio Compositions"]
#+END_SRC

Now:

#+BEGIN_SRC
#+FIRN_UNDER Projects "Audio Compositions"
#+END_SRC

* V.0.0.8
** Feature: Clean up unused attachments.
- Adds a configuration option to config.edn: ~run-build-clean?~ - which will
Expand Down

0 comments on commit 77d896e

Please sign in to comment.