Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 3.37 KB
Raw

Contributing to Nemo

🎉 Thanks for taking the time to contribute! 🎉

This project and everyone participating in it is governed by the Code of Conduct.

Before contributing to our project, keep in mind that we go through the following simple steps:

  • Identify the change required for the project.
  • Search and check for existing, related JIRA tickets and pull requests. Make a new JIRA ticket if the problem is not pointed out.
  • Make sure that the change is important and ready enough for the community to spend time reviewing
  • Open the pull request following the PR template, clearly explaining and motivating the change.

When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.

Also, we have a dev list, where you can ask questions before contributing.

Things to know before getting started

How to contribute

  • Reporting Bugs
  • Suggesting Enhancements
  • Reviewing Pull Requests and Changes
  • Documentation Changes (website documentations can be changed through the links on our website)
  • JIRA Maintenance
  • Code Contribution

Pull Request Process

  1. Fork the GitHub repository at https://github.com/apache/incubator-nemo.
  2. Make sure the changes are required and discussed through JIRA, our issue tracker.
  3. Clone your fork, create a new branch like ISSUE#-SHORT_TITLE (e.g. 25-WebUI), push commits to the branch.
  4. Consider whether documentations or tests are needed as part of the change, and add them if needed.
  5. Run mvn clean install to verify that the code runs and tests pass.
  6. Open a pull request following the PR template.
  • the PR title should be of form [NEMO-##] Title, specifying the relevant JIRA ticket number, and a short description of the change.
  • if the PR is still a work in progress and is not ready to be merged, add [WIP] before the title.
  • Set yourself as the assignee, this is a little trick for how we easily identify the author of each PRs.
  • Consider identifying the reviewer of the PR, with the suggestions provided by GitHub.
  • Be sure to replace the #GITHUB_PR_NUMBER on your PR message with the appropriate PR number on GitHub, by hitting on edit after sending your PR.