Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.68 KB

CONTRIBUTING.adoc

File metadata and controls

50 lines (32 loc) · 2.68 KB

Contributing

We – the maintainers of this project and the City of Barcelona – value your input, enjoy feedback and welcome improvements to our Open Source projects.

We love issues and pull requests from everyone.

Problems, suggestions and questions

You don’t need to change any of our code or documentation to be a contributor. Many contributors add to our software by reporting problems, suggesting changes and asking simple and difficult questions. To do this, you can create a GitHub Issue for this project.

Documentation and code

If you want to add to the documentation or code of one of our projects you should make a Pull Request. If you never used GitHub, get up to speed with Understanding the GitHub Flow.

Make your changes

Add your changes in commits with a message that explains them. Document choices or decisions you make in the commit message, this will enable everyone to be informed of your choices in the future.

If you are adding code, make sure it adheres to the project’s code and documentation style guide before you submit your pull request.

Pull Request

When submitting the pull request, please accompany it with a description of the problem you are trying to address and the issue numbers that this Pull Request fixes/addresses.

Improve

It could be that your contribution can be merged immediately by a maintainer. However, usually, a new Pull Request needs some improvements before it can be merged. Other contributors (or helper robots) might have feedback. If this is the case the reviewing maintainer will help you improve your documentation and code.

If your documentation and code have passed human review and have passed the automated tests, it is merged.

AsciiDoc edition guidelines

This chapter is specifically for telling you which conventions we have for writing the documentation in AsciiDoc. If you are new in AsciiDoc, please, start reading this.

Specific project rules

  • Each sentence in one line (understanding a sentence when it finishes with '.').

  • For images, set always its real width (e.g. image::ScrumInfographic.svg[Scrum info-graphic, width=2835])

  • Info-graphics that have text always in .svg format for facilitating its edition.

  • Only use TIP, WARNING and IMPORTANT as Admonitions.

  • In case to need to associate an existing style to a paragraph, write the style ID at the top of the paragraph: [.my-paragraph-style]

  • Use '*' for bullet lists