Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
453 additions
and
183 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # 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, sex characteristics, gender identity and expression, | ||
| level of experience, education, socio-economic status, 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 within all project spaces, and it also applies when | ||
| an individual is representing the project or its community in public spaces. | ||
| 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 conduct@keithp.com. All | ||
| complaints will be reviewed and investigated and will result in a response that | ||
| is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
|
|
||
| For answers to common questions about this code of conduct, see | ||
| https://www.contributor-covenant.org/faq | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # Contributing to Snek | ||
|
|
||
| We welcome contributions of all forms, including patches to code and | ||
| documentation, issue reports, or just kind words. | ||
|
|
||
| ## Getting Current Source Code | ||
|
|
||
| Snek sources are maintained in git and hosted in two places. | ||
|
|
||
| 1. [keithp.com](https://keithp.com/cgit/snek.git/). This is the | ||
| 'canonical' source location. | ||
|
|
||
| 2. [github](https://github.com/keith-packard/snek). This should | ||
| exactly mirror the code at keithp.com. I've placed it here to | ||
| make contributing to Snek easier for people familiar with github. | ||
|
|
||
| You can create a local copy of the repository with git clone: | ||
|
|
||
| $ git clone git://keithp.com/git/snek.git | ||
|
|
||
| or | ||
|
|
||
| $ git clone https://github.com/keith-packard/snek.git | ||
|
|
||
| ## Lola | ||
|
|
||
| The only non-standard tool used to build Snek is “lola”, which is a | ||
| custom LL parser generator designed to construct compact parse tables | ||
| for simple languages, like Snek. That's also available on both | ||
| keithp.com and github: | ||
|
|
||
| 1. [keithp.com](https://keithp.com/git/lola.git/). | ||
| 2. [github](https://github.com/keith-packard/lola). | ||
|
|
||
| Just like Snek, you can get it from either place using: | ||
|
|
||
| $ git clone git://keithp.com/git/lola.git | ||
|
|
||
| or | ||
|
|
||
| $ git clone https://github.com/keith-packard/lola.git | ||
|
|
||
| Lola is a Python program; installing it is a simple matter of copying | ||
| the script someplace in your path. You can use the Makefile for that | ||
| if you like: | ||
|
|
||
| $ cd lola | ||
| $ make install | ||
|
|
||
| The default location is /usr/local/bin | ||
|
|
||
| ## Building Snek from Source | ||
|
|
||
| Snek uses simple Makefiles. Because so much of snek targets embedded | ||
| systems, using a more sophisticated system like meson is actually | ||
| pretty hard. | ||
|
|
||
| $ cd snek | ||
| $ make | ||
|
|
||
| ## Patch Submission | ||
|
|
||
| You can submit patches in a couple of ways: | ||
|
|
||
| 1. Mail to the snek list (see below). This can be tricky as it | ||
| requires a friendly email system, and you'll have to subscribe to | ||
| the mailing list before it will let you post anything | ||
| (sigh). Here's a simple example sending the latest patch in your | ||
| local repository to the list: | ||
|
|
||
| $ git send-email --to snek@keithp.com HEAD^ | ||
|
|
||
| 2. Generate a pull-request in github. | ||
|
|
||
| 1. Fork the snek project into your own github account | ||
| 2. Push patches to that repository | ||
| 3. While viewing your repository, click on the 'New pull request' | ||
| button and follow the instructions there. | ||
|
|
||
| ## Issue Tracking | ||
|
|
||
| We're using the issue tracker on Github for now; if you have issues, | ||
| please submit them to the | ||
| [Snek Issue Tracker](https://github.com/keith-packard/snek/issues) | ||
|
|
||
| ## Mailing List | ||
|
|
||
| Snek has a mailing list, hosted at keithp.com. You can | ||
| [subscribe here](https://keithp.com/mailman/listinfo/snek). | ||
| This is a public list, with public archives. Participants are expected | ||
| to abide by the Snek Code of Conduct. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Snek uses the | ||
| [Contributor Covenant](https://www.contributor-covenant.org/), which | ||
| you'll find in the source tree. Please help make Snek a kind and | ||
| welcoming environment by following those rules. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.