Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing guidelines #32

Merged
merged 2 commits into from Jun 8, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,35 @@
# Contributing

Thank you for contributing to Rel茅!

To make the experience as easy as possible, we ask that you follow some simple
guidelines. Use your best judgment, and feel free to propose changes to this document
in a pull request.

Additionally, be sure that you read and follow our
[Code of Conduct](https://github.com/mercadona/rele/blob/master/CODE_OF_CONDUCT.md).

## Code

We ask that you start a discussion before attempting to make a code contribution. For feature
requests, issues, bugs, etc. please
[create an issue via Github](https://github.com/mercadona/rele/issues/new) where we can all
discuss the contribution to the project.

It is always best to have community input before proposing changes that may later be rejected.

### Pull Requests

* Make sure any code changes are covered by tests by running `make test`.
* Run `make lint` on any modified files.
* If your branch is behind master,
[rebase](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request) on top of it.

## Issues

When you open an issue make sure you include the full stack trace and
that you list all pertinent information (operating system, Python implementation, etc.)
as part of the issue description.

Please include a minimal, reproducible test case with every bug
report.