diff --git a/code-of-conduct.md b/code-of-conduct.md deleted file mode 100644 index 96d2d04..0000000 --- a/code-of-conduct.md +++ /dev/null @@ -1,74 +0,0 @@ -# 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 behaviour 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 behaviour by participants include: - -* The use of sexualised 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 -behaviour and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behaviour. - -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 behaviours 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 behaviour may be -reported by contacting the project team at tituswormer@gmail.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 . - -[homepage]: https://www.contributor-covenant.org diff --git a/contributing.md b/contributing.md deleted file mode 100644 index d1b36dc..0000000 --- a/contributing.md +++ /dev/null @@ -1,138 +0,0 @@ -# Contributing - -> This project has a [Code of Conduct][coc]. By interacting with this -> repository, organisation, or community you agree to abide by its terms. - -Hi! 👋 Exciting that you’re interested in contributing! Before doing so, take -a moment to read the following guidelines. And thanks for contributing to -**unist**! 👏👌✨ - -Before anything else: people involved with this project often do so for fun, -next to their day job: you are not entitled to free customer service. - -## Table of Contents - -* [Ecosystem](#ecosystem) -* [Questions](#questions) -* [Contributions](#contributions) - * [Improve documentation](#improve-documentation) - * [Improve issues](#improve-issues) - * [Give feedback on issues](#give-feedback-on-issues) - * [Write code](#write-code) -* [Submitting an issue](#submitting-an-issue) -* [Submitting a pull request](#submitting-a-pull-request) -* [Resources](#resources) - -## Ecosystem - -The ecosystem consists of several organisations and separate projects: most of -them are tiny, and many of them have a utility -([`mdast-util-to-hast`][mdast-util-to-hast]), a plugin -([`remark-rehype`][remark-rehype]), and relate to an ecosystem -([`remark`][remark]). Try and pick the right place to contribute to so we can -help you faster. - -## Questions - -Please chat and ask questions on spectrum! Jump in there and lurk, talk to us, -and help others. - -* [**unified**](https://spectrum.chat/unified/unified) - — Topics relating to [**unified**][unified] in general -* [**vfile**](https://spectrum.chat/unified/vfile) - — Topics relating to [**vfile**][vfile]: virtual files -* [**syntax-tree**](https://spectrum.chat/unified/syntax-tree) - — Topics relating to [**syntax-tree**][syntax-tree] and [**unist**][unist] -* [**remark**](https://spectrum.chat/unified/remark) - — Topics relating to the [**remark**][remark] ecosystem, markdown, - and [**mdast**][mdast] -* [**rehype**](https://spectrum.chat/unified/rehype) - — Topics relating to the [**rehype**][rehype] ecosystem, HTML, - and [**hast**][hast] -* [**retext**](https://spectrum.chat/unified/retext) - — Topics relating to the [**retext**][retext] ecosystem, natural language, - and [**nlcst**][nlcst] - -## Contributions - -There’s several ways to contribute, not just by writing code. - -### Improve documentation - -As a user of this project you’re perfect for helping us improve our docs. -Typo corrections, error fixes, better explanations, new examples, etcetera. -Anything! - -### Improve issues - -Some issues lack information, aren’t reproducible, or are just incorrect. -Help make them easier to resolve. - -### Give feedback on issues - -We’re always looking for more opinions on discussions in the issue tracker. - -### Write code - -Code contributions are very welcome. It’s often good to first create an issue -to report a bug or suggest a new feature before creating a pull request to -prevent you from doing unnecessary work. - -## Submitting an issue - -* The issue tracker is for issues. Use chat for support -* Search the issue tracker (including closed issues) before opening a new - issue -* Ensure you’re using the latest version of projects -* Use a clear and descriptive title -* Include as much information as possible: steps to reproduce the issue, - error message, version, operating system, etcetera -* The more time you put into an issue, the more we will -* The best issue report is a [failing test][unit-test] proving it - -## Submitting a pull request - -* Non-trivial changes are often best discussed in an issue first, to prevent - you from doing unnecessary work -* For ambitious tasks, you should try to get your work in front of the - community for feedback as soon as possible -* New features should be accompanied with tests and documentation -* Don’t include unrelated changes -* Lint and test before submitting code by running `$ npm test` -* Write a convincing description of why we should land your pull request: - it’s your job to convince us - -## Resources - -* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) -* [Making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190) -* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) -* [GitHub Help](https://help.github.com) - -[coc]: https://github.com/unifiedjs/unified/blob/master/code-of-conduct.md - -[vfile]: https://github.com/vfile - -[syntax-tree]: https://github.com/syntax-tree - -[unist]: https://github.com/syntax-tree/unist - -[mdast]: https://github.com/syntax-tree/mdast - -[nlcst]: https://github.com/syntax-tree/nlcst - -[hast]: https://github.com/syntax-tree/hast - -[unified]: https://github.com/unifiedjs/unified - -[remark]: https://github.com/remarkjs/remark - -[retext]: https://github.com/retextjs/retext - -[rehype]: https://github.com/rehypejs/rehype - -[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast - -[remark-rehype]: https://github.com/remarkjs/remark-rehype - -[unit-test]: https://twitter.com/sindresorhus/status/579306280495357953 diff --git a/readme.md b/readme.md index 18c90a4..3517e99 100644 --- a/readme.md +++ b/readme.md @@ -511,21 +511,18 @@ implementing unist: ## Contribute -**unist** is built by people just like you! -Check out [`contributing.md`][contributing] for ways to get started. +See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for +ways to get started. +See [`support.md`][support] for ways to get help. +Ideas for new utilities and tools can be posted in [`syntax-tree/ideas`][ideas]. + +A curated list of awesome syntax-tree, unist, hast, mdast, and nlcst resources +can be found in [awesome syntax-tree][awesome]. This project has a [Code of Conduct][coc]. By interacting with this repository, organisation, or community you agree to abide by its terms. -Want to chat with the community and contributors? -Join us in [spectrum][chat]! - -Have an idea for a cool new utility or tool? -That’s great! -If you want feedback, help, or just to share it with the world you can do so by -creating an issue in the [`syntax-tree/ideas`][ideas] repository! - ## Acknowledgments The initial release of this project was authored by @@ -578,17 +575,21 @@ This work is licensed under a -[logo]: https://raw.githubusercontent.com/syntax-tree/unist/b187eb7/logo.svg?sanitize=true +[health]: https://github.com/syntax-tree/.github -[releases]: https://github.com/syntax-tree/unist/releases +[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md -[contributing]: contributing.md +[support]: https://github.com/syntax-tree/.github/blob/master/support.md -[coc]: code-of-conduct.md +[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md + +[awesome]: https://github.com/syntax-tree/awesome-syntax-tree [ideas]: https://github.com/syntax-tree/ideas -[chat]: https://spectrum.chat/unified/syntax-tree +[logo]: https://raw.githubusercontent.com/syntax-tree/unist/b187eb7/logo.svg?sanitize=true + +[releases]: https://github.com/syntax-tree/unist/releases [license]: https://creativecommons.org/licenses/by/4.0/