Skip to content

Latest commit

 

History

History
139 lines (91 loc) · 6.12 KB

CONTRIBUTING.md

File metadata and controls

139 lines (91 loc) · 6.12 KB
Raw

Contributing to Sous-Chef

First of all, thanks for reading this and taking time to contribute! 👍 We need volunteer developers to help this project grow.

The following is a set of guidelines for contributing to Sous-Chef, which is hosted in the Savoir-faire Linux organization on GitHub. Feel free to propose changes to this document in a pull request.

If you haven't already, please join us on IRC: #souschef on Freenode.

Useful resources

How can I contribute ?

Code contribution

A pre-requisite is to have Sous-Chef installed on your machine. The installation procedure is based on Docker and is described on GitHub.

Issues

If you are unsure where to begin contribution to Sous-Chef, you can start by looking through the issues page. Numerous issues are created and waiting for your love on the issue board.

You may also use Waffle as a more Agile-like dashboard.

Please refer to the issues labels and topics for more information on how categorizing the issues.

Pull Requests

Contributions will be accepted through the creation of Pull Requests. Here is the workflow:

  • Fork the repository into yours and work from there
  • Commit and push your changes into your fork
  • When you are done, create a Pull Request in Feast repository on the dev branch

A template is provided to create your Pull Request. Try to fill the information at the best of your knowledge.

Pull request checklist

For your pull request to be merged, the answer to the following questions must be 'yes':

General
  • Can the branch be merged automatically?
Testing
  • Do the unit tests pass?
Adding new code
  • Is the code PEP8 compliant?
  • Is the code covered by tests?
  • Are the strings internationalised?
  • Is the url templatetag used when declaring urls? (are the templates exempt of hardcoded urls?)

TravisCI is configured to run those checks on every Pull-Request. It is recommanded you configure your fork to do the same.

Note: You may have a "coverage decreased" message after creating the pull request. It may happen with trivial changes: example1, example2. Don't worry about it in these cases. We will verify the commits.

Documentation

Documentation is important and can always be improved:

  • Installation instructions
  • Test procedures
  • How to help translating the project
  • Updating the Roadmap

The prefered syntax is Asciidoc. Markdown is also accepted.

The project wiki on GitHub could also be used.

Reporting bugs

Bugs are tracked as GitHub issues.

How to submit a good bug report

Please include as many details as possible. An issue template is automatically loaded when you create an issue.

  • Use a clear and comprehensive title for the issue
  • Describe the expected behaviour in as many details as possible
  • Describe the actual behaviour in as many details as possible
  • Detail the steps which reproduce the problem
  • Include screenshots and animated GIFs. You can use this tool on Linux.

Testing the application

Our development process is based on Continuous Integration. We love to have a nice code coverage!

Each Django module comes with its own tests.py file. Feel free to implement missing unit or functional tests.

Translating

Sous-Chef is a bilingual (French/English) application and needs your talent of translators!

We use Transifex to translate the Sous-Chef project. Please visit Sous-Chef on Transifex if you are interested!

Additional notes

Issue labels

Label name Description
enhancement Feature requests.
bug Confirmed bugs or reports that are very likely to be bugs.
question Questions more than bug reports or feature requests (e.g. how do I do X).
advanced The Sous-Chef core team would appreciate help from the community in resolving these more complex issues.
beginner Less complex issues which would be good first issues to work on for users who want to contribute to Sous-Chef.
duplicate Issues which are duplicates of other issues, i.e. they have been reported before.
wontfix The core team has decided not to fix these issues for now, either because they're working as intended or for some other reason.
invalid Issues which aren't valid (e.g. user errors).

Issue topics

When applicable, the issue topics often refer to the Django application name.

Label name Description
member Related to client management.
order Related to the orders and order items management.
billing Related to the billing system.
documentation Related to any kind of documentation.
frontend Related to Semantic UI integration, or Javascript problems.
migration Related to the data migration from the old application.
i18n Related to any kind of internationalization problem.
python Related to python programming.
tests Related to unit tests, functional tests or manual testing.
ux/ui Related to user experience, user interface, design.