When contributing to this repository, please discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, follow it in all your interactions with the project.
Each folder has a <STYLE>-README.md file in it. Please read it before contributing to that section. The read me is where the details for that folder are found. This contributing file has some information but it is only the highlights. The <STYLE>-README.md files have all the necessary information you should know before contributing.
There are principles for contributing to each folder. Currently I know the kata and yatate files really well so I will start with those. As this repo grows I will add more guidelines for other folders. If you have ideas for improvement please make an example and start an issue so we can discuss your perspective.
- yatate-readme for all details.
- A Yatate file can be in the format of
.txtor.md. Please keep this file readable. - The file name for the sifu's yatate file is
<SIFU-CALL-SIGN>.txt.
- kata-readme for all details.
<STYLE>-katas.md- the intent of katas is to be have no code. Only a description of what the sifu should do.- All katas are labeled as
### Position <NUMBER>: <TITLE-OF-KATA>. - Title is followed by a bulleted description of what the sifu should do. I like step by step but paragraph format is acceptable also.
- Katas are added at the bottom of each file and numbered sequentially. This sets up a chronology and makes it easier to reference for sifus in the future.
- All katas are labeled as
<STYLE>-guide.md- the intent of the guide is to help sifus learn. There are multiple ways to solve any programming challenge. The guide shows one way to solve the kata in detail.- The guide is the place to outline all the details for accomplishing a kata "position".
- List steps in bullets so they are easy to follow.
- use back ticks to highlight code like so
code to do something - or you can use multiple backticks to highlight sections of code like so
/// do some code here- Top of the style guide has general <STYLE> commands and patterns.
- Bottom of a style guide is where a sifu will add new Position guides with the corresponding code. The code should be detailed enough that a sifu could cut and paste it.
- Fork the "BJD" repo.
- Create a pull request with details of changes to the interface, this includes useful file locations.
- Name a branch of your fork so that is what gets merged. Please do not make changes to master.
- We will merge the Pull Request once you have the sign-off of other dojo sifus (sifus are found in the Yatate folder), the reviewer will be responsible for merging the request.
- *TO DO create a list in the Github projects section that list current items that would be helpful.
- As of today (1/14/2019) it would be helpful to have
- more katas and guides for sifus.
- Sponsors for venues, food, drinks, or speakers.
- Marketing to help us spread the word.
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, nationality, personal appearance, race, religion, or sexual identity and orientation.
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
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.
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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at trewaters@hotmail.com. 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.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4