[GitHub] jooykim closed pull request #10: [NEMO-31] Community Standards

[GitBox <gi...@apache.org>]

jooykim closed pull request #10: [NEMO-31] Community Standards
URL: https://github.com/apache/incubator-nemo/pull/10
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
new file mode 100644
index 00000000..ae2231f1
--- /dev/null
+++ b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [dev@nemo.apache.org](mailto:dev@nemo.apache.org). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000..80d0cd99
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,44 @@
+# Contributing to Nemo 
+
+:tada: Thanks for taking the time to contribute! :tada:
+
+This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+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](https://issues.apache.org/jira/projects/NEMO/issues) and [pull requests](https://github.com/apache/incubator-nemo/pulls). 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](ㄱpull_request_template.md), 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.
+
+## Things to know before getting started
+
+- [Our Docs](http://nemo.apache.org/docs/home/)
+- [Apache Beam](https://beam.apache.org/)
+- [Apache Spark](http://spark.apache.org/)
+- [HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html)
+- [Apache REEF](http://reef.apache.org/)
+- Big Data Workloads like [MR](https://en.wikipedia.org/wiki/MapReduce), [PageRank](https://en.wikipedia.org/wiki/PageRank), [Multinomial Logistic Regression](https://en.wikipedia.org/wiki/Multinomial_logistic_regression)..
+
+## 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](http://nemo.apache.org/))
+- JIRA Maintenance
+- Code Contribution
+
+## Pull Request Process
+
+1. [Fork](https://github.com/apache/incubator-nemo#fork-destination-box) the GitHub repository at `https://github.com/apache/incubator-nemo`.
+2. Make sure the changes are required and discussed through [JIRA](https://issues.apache.org/jira/projects/NEMO/issues), 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](https://github.com/apache/incubator-nemo/pull/new/master) following the [PR template](pull_request_template.md).
+  - 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.
+  - Consider identifying the reviewer of the PR, with the suggestions provided by GitHub.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..a2775b29
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,15 @@
+JIRA: [NEMO-##: TITLE](https://issues.apache.org/jira/projects/NEMO/issues/NEMO-##)
+
+**Major changes:**
+- 
+
+**Minor changes to note:**
+- 
+
+**Tests for the changes:**
+- 
+
+**Other comments:**
+- 
+
+resolves [NEMO-##](https://issues.apache.org/jira/projects/NEMO/issues/NEMO-##)
diff --git a/README.md b/README.md
index 8dee6662..496cc395 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,9 @@ A Data Processing System for Flexible Employment With Different Deployment Chara
 Details about Nemo and its development can be found in:
 * Our website: https://nemo.apache.org/
 * Our project wiki: https://cwiki.apache.org/confluence/display/NEMO/
+* Our Dev mailing list for contributing: dev@nemo.apache.org [(subscribe)](mailto:dev-subscribe@nemo.apache.org)
+
+Please refer to the [Contribution guideline](.github/CONTRIBUTING.md) to contribute to our project.
 
 ## Nemo prerequisites and setup
 


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services