Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 3.76 KB

File metadata and controls

72 lines (43 loc) · 3.76 KB

Contributing to Concise

Welcome to Concise! We are not only here to make it as simple as possible to build websites, but also to contribute to the project.

By following this guide to contributing, we can make sure that everything is up to code (pun intended), everything is formatted properly, and we are posting bug reports, feature requests, and questions in the proper area.

Sound good? Let's move on...

Bug reports, feature requests, and questions

** Thanks to thoughtbot for this great way to handling questions for an open source project.

In lieu of a mailing list, we are going to manage all specific questions through Stack Overflow.

Members of the Concise team are subscribed to specific tags via Stack Exchange Filters so that if a question is properly tagged, we can respond in a timely manner and help.

Which tags?

Ideally, we would like to keep it to just one tag for Concise questions, but we are subscribed to multiple variants to make sure nothing passes by us. However, for everybody asking a question, please use:

Where do I post this?

There are lots of different things that people will want to post regarding the Concise framework. Here is a rough outline of where you should post any given issue, question or contribution:

Feature Requests

Do you think that there should be something in Concise that isn't already included? Before you start writing code and implementing a feature, make sure that it is something that fits into the idea and scope of the project. We are a lightweight, bloat-free framework that focuses on removing the unnecessary.

If you are unsure of whether or not your feature would be a good fit for the framework, posting in GitHub Issues and tagging it info:feedback-needed or type:idea will help us filter your feature request and evaluate the idea.

Contributing

  1. Fork us
  2. Create a feature branch (git checkout -b my-feature)
  3. Follow the coding style guide
  4. Test any and all changes you make or implement.
  5. Commit changes (git commit -am My new feature`)
  6. Push to your feature branch (`git push origin my-feature)
  7. Create a new Pull Request
  8. Wait for a response from us (we promise to be semi-prompt)

Coding Style Guide

** Thanks to Bootstrap for providing a good outline for coding styles.

Consistency is great, especially when writing code. Here we have a few simple guidelines to follow if you are going to be contributing to Concise.

HTML

Follow @mdo's Code Guide

CSS

Follow @mdo's Code Guide

JavaScript

  • Avoid adding if at all possible
  • No tabs, use two spaces
  • Proper indentation

License

By contributing to Concise, you agree that your code can be released under the MIT license