Merge pull request #66 from Coastal-Imaging-Research-Network/SBFRF-Co…

…ntribution-Guidlines

Sbfrf contribution guidlines

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Code of Conduct
+
+## 1. Purpose
+
+A primary goal of cBathy_Toolbox is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in cBathy_Toolbox to help us create safe and positive experiences for everyone.
+
+## 2. Open Source Citizenship
+
+A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+
+Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
+
+If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
+
+## 3. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+*   Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+*   Exercise consideration and respect in your speech and actions.
+*   Attempt collaboration before conflict.
+*   Refrain from demeaning, discriminatory, or harassing behavior and speech.
+*   Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+*   Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+## 4. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+*   Violence, threats of violence or violent language directed against another person.
+*   Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+*   Posting or displaying sexually explicit or violent material.
+*   Posting or threatening to post other people’s personally identifying information ("doxing").
+*   Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+*   Inappropriate photography or recording.
+*   Inappropriate physical contact. You should have someone’s consent before touching them.
+*   Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
+*   Deliberate intimidation, stalking or following (online or in person).
+*   Advocating for, or encouraging, any of the above behavior.
+*   Sustained disruption of community events, including talks and presentations.
+
+## 5. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 6. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. [email protected] [email protected] [email protected].
+
+
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 7. Addressing Grievances
+
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify Coastal Imaging Research Network with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
+
+
+
+## 8. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
+
+This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
+
+## 9. Contact info
+
+[email protected] [email protected] [email protected]
+
+## 10. License and attribution
+
+This Code of Conduct is distributed under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
+
+Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
+
+Retrieved on November 22, 2016 from [http://citizencodeofconduct.org/](http://citizencodeofconduct.org/)

docs/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+cBathy Contribution Guidlines
+=============================
+
+If you're here, that means you're considering contributing to the development of [cBathy](https://doi.org/10.1002/jgrc.20199).
+That's exciting and we're glad you're here!  This is an open and welcoming community but to keep some semblance of order, 
+a few rules and suggestions for contributions.  :) 
+
+These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+Please see the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) 
+
+
+Git Development Conventions:
+----------------------------
+The rules for new feature enhancement is laid out below:
+
+- The main branch for releases is `master`.  Each new release is marked with a tag for release.
+
+- The main development branch is `development`.  
+
+- Each new feature is developed on a `[new feature]` branch. 
+
+- To contribute:
+  - create a topic branch (`[new feature]`) from where you want to base your work.
+  - This is usually the `development` branch.
+  - Only target `release` branches if you are certain your fix must be on that branch.
+  - Please avoid working directly on the `master` branch.
+
+- Make commits of logical and atomic units.
+
+- Make sure your commit messages are in the proper format.  If they identify a established issue please identify in your commit
+
+- Make sure you have added the necessary tests for your changes or bug fixes.
+
+Submit a [pull request!](https://help.github.com/articles/creating-a-pull-request/)
+
+At this point you're waiting on us. We like to at least comment on pull requests within three to five business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+- Write tests.
+- Follow our style guide.
+- Write a good commit message.
+
+**FORKS**
+if you're not comfortable developing in the main repository, you can try forking!  We do ask that when you've made developments
+that do still submit a pull request from your forked repository back to the main (upstream) repository. 
+
+Testing Proceedure 
+------------------
+Each new release (version) is merged after extensive testing proceedures listed below.  
+> Lay out testing proceedure here 
+(We would love for someone to develop automated testing environemnt)
+
+**Merging from `[new feature]` to `development` for enhancement** 
+We currently do not have an automated testing environment for each pull request.  There are manual tests that are run when
+merging from `[new feature]` to `development`.  
+
+**Merging from `development` to `master` for new release** 
+New releases need to be throughly vetted ... list proceedure here
+
+TODOs 
+-----
+We have a list of contributions that people who are new to the community (or seasoned verterans) 
+Currently they're in the issues tab, but if people have other suggestions we're open to suggestions 
+We've tried to create tags that help users identify contributions that they can make based on their comfortablity with the status
+
+Comments Required
+-----------------
+Please comment code thoroughly and professionally
+
+Variable name convention
+------------------------
+please use explicit variable names so others can understand the variable name (don't be worried about variable name length)
+it's better to have a variable name like `significantWaveHeight` instead of `H`.  It is more clear. 
+
+Please see established coding conventions from the WIKI page that include variable name convention
+https://github.com/Coastal-Imaging-Research-Network/Forum-Wiki/wiki/Coding-Standards
+
+> _establish variable name convention (camel humps? underscores? others?)_
+
+Changing Role
+-------------
+If you would like to change your role within the repository submit a request [here](https://goo.gl/forms/7VX5isIpHrV1jSlH2)
+
+please be sure to use a valid GitHub user name.