-
-
Notifications
You must be signed in to change notification settings - Fork 388
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Contributing.md and ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE #1113
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
**Checklist** | ||
|
||
- [ ] Bug Report - The issue you are reporting might be there already. Please search on the [issues tracker](https://github.com/openfoodfacts/openfoodfacts-server/issues) before creating or reporting a issue. | ||
|
||
- [ ] Before reporting, please ensure (if you can) that you have tested it with the latest (dev) version of the software. | ||
|
||
- [ ] Don't forget to tag your issue, it makes it easier to discover. | ||
|
||
**Summary:** | ||
|
||
Summarize your issue in one sentence (what goes wrong, what did you expect to happen) | ||
|
||
**Steps to reproduce:** | ||
|
||
How can we reproduce the issue? | ||
|
||
**Add system logs:** | ||
|
||
Add logcat files here (if you are able to add). | ||
|
||
**Expected behavior:** | ||
|
||
What did you expect the app to do? | ||
|
||
**Observed behavior:** | ||
|
||
What did you see instead? Describe your issue in detail here. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## Description | ||
|
||
Describe the changes made and why they were made instead of how they were made. | ||
|
||
## Related issues and discussion | ||
#{Issue Number} | ||
|
||
|
||
## Checklist | ||
|
||
Make sure you've done all the following (You can delete the checklist before submitting) | ||
|
||
- [ ] Code is well documented | ||
- [ ] Include unit tests for new functionality | ||
- [ ] Code passes Travis builds in your branch | ||
- [ ] If you have multiple commits please combine them into one commit by squashing them. | ||
- [ ] Read and understood the [contribution guidelines](https://github.com/openfoodfacts/openfoodfacts-server/blob/master/CONTRIBUTING.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Join the development | ||
* Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore.You'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app. | ||
* If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely. | ||
|
||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, or the official [slack channel](https://slack-ssl-openfoodfacts.herokuapp.com/). | ||
|
||
## Pull Request Process | ||
|
||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a | ||
build. | ||
2. Check that there are no conflicts and your request passes [Travis](https://travis-ci.org) build. Check the log of the pass test if it fails the build. | ||
3. Give the description of the issue that you want to resolve in the pull request message. The format of the commit message to be fixed - **Fixes #[issue number] [Description of the issue]** Example: **Fixes #529: Add toast warning in `MainActivity.java`** | ||
4. Wait for the maintainers to review your pull request and do the changes if requested. | ||
|
||
## Contributions Best Practices | ||
|
||
### Commits | ||
|
||
* Write clear meaningful git commit messages (Do read [here](http://chris.beams.io/posts/git-commit/)) | ||
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (For more info click [here]( https://github.com/blog/1506-closing-issues-via-pull-requests)) | ||
* When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [here](https://davidwalsh.name/squash-commits-git ) | ||
* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker. | ||
|
||
### Feature Requests and Bug Reports | ||
* When you file a feature request or when you are submitting a bug report to the [issue tracker](https://github.com/openfoodfacts/openfoodfacts-server/issues), make sure you add steps to reproduce it. Especially if that bug is some weird/rare one. | ||
|
||
## Code of Conduct | ||
|
||
For our Code of Conduct, you should head over [here](https://en.wiki.openfoodfacts.org/Code_of_conduct) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a CoC in the Wiki: https://en.wiki.openfoodfacts.org/Code_of_conduct Maybe we should link to that instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay thats great I will link it to that.