Skip to content
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 basic style guidelines #156

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Style Guidelines

This repository is owned and controlled by [Women Who Code Boulder/Denver](https://github.com/wwcodecolorado)

We welcome contributions!
- Code suggestions
- Feature requests
- Specification improvements
- Bug reports
- Bug fixes

## Github Flow

We use Github to host our code. Pull requests may be opened by anyone and can be a source for future change facilitated by Women Who Code Boulder/Denver.
All merges to Scrollodex repository will be approved by a member of Women Who Code Boulder/Denver.
Women Who Code Boulder/Denver will retain final decision-making control and exclusive merge access to this Scrollodex repository.

## Contribution Guidelines
We appreciate your contributions. It is recommended to propose contributions by opening a new issue or assigning yourself an already opened issue.
If you have questions about an issue leave it as a comment in the issue.

### Pull Requests

1. Fork the repo and create your branch from `main`.
2. If you've added code, please make sure it is well tested and correctly formatted.
3. Please make sure to update all corresponding documentation.
4. Open the pull request!
5. A member of the Women Who Code Boulder/Denver volunteer team will work with you on progressing/ merging your change.

Pull request may follow one of two paths:
1. Acceptance, meaning that a Women Who Code Boulder/Denver volunteer will review it and merge into codebase or add a 'hacktoberfest-accepted' label
2. Rejection, meaning a Women Who Code Boulder/Denver volunteer will either flag the PR as 'invalid' or 'spam' or close the pull request

## Any contributions you make will be under the [MIT](https://choosealicense.com/licenses/mit/) License
All submissions are made subject to the conditions in the [LICENSE](./LICENSE) file.

## Report bugs using Github's Issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Write bug reports with detail, background, and sample code.