Merge pull request #219 from contraexemplo/community-relations
New README, contribution guidelines and issue templates
This commit is contained in:
leogermani
GitHub
commit
7f00b1eb4d
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Is something not working as expected? Report it here
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Bug description**
|
||||
|
||||
What is happening?
|
||||
|
||||
**How to reproduce such bug**
|
||||
|
||||
Use the following template to create a step-by-step guide:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
|
||||
What did you expect to happen?
|
||||
|
||||
**Screenshots**
|
||||
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context about the problem here.
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest a new feature to our Tainacan devs! 🎉
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Context and motivation**
|
||||
|
||||
Why do you think this feature is needed? Who would benefit from it?
|
||||
|
||||
**Ideal solution**
|
||||
|
||||
What would you describe as the best solution to implement such feature?
|
||||
|
||||
**Alternative solutions**
|
||||
|
||||
Is there any other way to implement it?
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context or screenshots about the feature request here.
|
||||
46
README.md
46
README.md
|
|
@ -1,17 +1,49 @@
|
|||
[](https://travis-ci.org/tainacan/tainacan) [](https://waffle.io/tainacan/tainacan)
|
||||
|
||||
# Tainacan
|
||||
- Tainacan's [plugin](https://wordpress.org/plugins/tainacan/) and [theme](https://wordpress.org/themes/tainacan-interface/) on WordPress.org
|
||||
- [Access our homepage](http://tainacan.org)
|
||||
- [Read our official documentation](https://wiki.tainacan.org/)
|
||||
- [Explore our blog](http://tainacan.org/blog/)
|
||||
- [Join our mailing list](https://lists.riseup.net/www/info/tainacan)
|
||||
- [Follow us on Twitter](https://twitter.com/tainacan_l3p)
|
||||
|
||||
** This is the development repository of a new version of Tainacan. If you are looking for the current stable version, please visit http://github.com/medialab-ufg/tainacan. **
|
||||
### What is Tainacan?
|
||||
|
||||
Tainacan is a WordPress plugin to build digital repositories. Manage and publish digital collections of any kind.
|
||||
|
||||
In this repository, we are building a new version of tainacan. The package will be composed of a WordPress plugin (this repository) and a WordPress Theme. More details of the architecture will be added here soon.
|
||||
[][youtube_demo]
|
||||
|
||||
We plan to mantain this repository well documented to encourage early testers and contributors, so feel free to try it.
|
||||
[youtube_demo]: https://www.youtube.com/watch?v=6q42dlcwW5g
|
||||
Get to know Tainacan with our [introduction video](https://www.youtube.com/watch?v=6q42dlcwW5g).
|
||||
|
||||
First, get to know the [key concepts](docs/key-concepts.md) of tainacan and what it does. After that you may want to learn [how to set up your local enviroment](docs/setup-local.md).
|
||||
Tainacan is a software solution for building, managing and publishing digital repositories of any kind on WordPress. Manage and publish you digital collections as easily as publishing a post to your blog, while having all the tools of a professional repository platform. It is composed of a WordPress plugin, which is being developed on this repository, and an optional [companion WordPress theme](https://github.com/tainacan/tainacan-theme) especially designed to produce beautiful digital exhibits. [Try it out!](http://demo.tainacan.org/)
|
||||
|
||||
We are still in early stages of development, and any help, feedback or contribution is welcome. Please drop us a line opening an issue or via one of our communication channels:
|
||||
### Features
|
||||
|
||||
* twitter: @tainacan_l3p
|
||||
**Easy installation**. As a WordPress plugin, Tainacan can be easily installed on and integrated to an existing WordPress website.
|
||||
|
||||
**Metadata and filters**. Use a metadata standard or choose whatever set of metadata you want to describe the items in your collections. You can choose which metadata will be used as a filter when browsing the collection.
|
||||
|
||||
**Faceted search**. Browse your collection (and let the public browse it) using a faceted search interface with the filters you have chosen.
|
||||
|
||||
**Manage taxonomies**. Manage vocabularies that can be used accross all your collections.
|
||||
|
||||
**Themes**. Tainacan [has its own default theme](https://wordpress.org/themes/tainacan-interface/), which helps you present your collections in a beautiful and effective way as it is developed to incorporate all of Tainacan functionalities. However, it will also work with any WordPress theme. For developers, it will be easy to add Tainacan specific features to an existing theme.
|
||||
|
||||
**API and interoperability**. Tainacan implements a RESTful API (read and write) to allow other applications to interact with your repository. Expose you collection in different formats, such as JSON, JSON-LD and OAI-PMH. If your collection uses a custom standard, you can map it to well-known stardards such as DublinCore.
|
||||
|
||||
### Showcases
|
||||
|
||||
Check out the digital exhibits from [Museu do Índio](http://tainacan.museudoindio.gov.br/) and [Museu Histórico Nacional](http://mhn.acervos.museus.gov.br/) to see Tainacan in action!
|
||||
|
||||
### Support
|
||||
|
||||
In addition to [our documentation](https://wiki.tainacan.org/) and [instructional videos](https://youtu.be/oEl9bWe_rWI), we provide technical support on our [mailing list](https://lists.riseup.net/www/info/tainacan) in English, Portuguese and Spanish. You are welcome to send all of your questions!
|
||||
|
||||
### Contributing
|
||||
Tainacan is a free, open source software licensed under **GPLv3**. Contributions to the codebase will abide to the same license; other contributions may be under additional or other terms.
|
||||
|
||||
To contribute with our project, you can report bugs and other issues, or suggest new features. You are also free to submit pull requests or translate Tainacan to multiple languages. If you are interested in contributing, you can get started by reading our [contribution guidelines](docs/CONTRIBUTING.md).
|
||||
|
||||
### Acknowledgements
|
||||
Tainacan is the results of continuous efforts from developers, researchers, policy makers and GLAMs in Brazil. We are eternally grateful for all of [our amazing contributors](https://github.com/tainacan/tainacan/graphs/contributors)!
|
||||
|
|
|
|||
|
|
@ -0,0 +1,23 @@
|
|||
## Contribution guidelines
|
||||
|
||||
Interested in contributing to Tainacan? That's awesome! :muscle: In this page, we'll talk about paths of contribution and what we consider a quality contribution.
|
||||
|
||||
### Our language policy
|
||||
While Tainacan is a Brazilian project, we have adopted English as our primary language on development matters. Writing comments in Portuguese on [issues](https://github.com/tainacan/tainacan/issues) and [pull requests](https://github.com/tainacan/tainacan/pulls) is allowed as long as you provide an English translation of your comments. Writing comments in Portuguese on commits is expressively prohibited. Comments on the codebase and variable names should also be written in English only.
|
||||
|
||||
### Thinking about how you can contribute
|
||||
|
||||
Ask yourself the following questions: do you work, directly or indirectly, with cultural preservation? If yes, what do you do? If not, are you just a curious person just excited about it? What kind of skills do you have? Is there something you find fun to do you think you can shape as a contribution to Tainacan?
|
||||
|
||||
Free and open source projects offer a diversity of contributions options that go from direct involvement with the development of a software (submiting patches to eliminate a bug, implementing new features, creating new tests) to works related to localization (translating the software interface), design (creative works), user experience (testing new iterations of Tainacan and reporting issues), documentation (contributing to our wiki with new articles or improving existing ones) and communication (creating videos about Tainacan, giving talks mentioning it). Here, we'll talk about in particular about contributions to this repository.
|
||||
|
||||
### Issue system
|
||||
An issue is a thread within the project's GitHub repository focused on debating bugs, feature requests or errors one may stumble upon. To gather as much information as possible and organize discussions to be clearer and more searchable, this repository has a few templates for the most common issues:
|
||||
|
||||
#### Bug report
|
||||
If something is not working properly on Tainacan, use this template.
|
||||
|
||||
#### Feature request
|
||||
If you have any feature ideas you would like to suggest to our developers, use this template.
|
||||
|
||||
A great issue is one that includes a concise description of errors you are stumbling upon along with crucial information such as which version of Tainacan you are using, which web browser, or which WordPress version. It's also important to search our repository for duplicates—and if you find one, opt to participate in the original discussion adding new information instead of creating your own. That will help contributors and users to keep track of a specific subject more easily.
|
||||
Loading…
Reference in New Issue