-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a04bc1e
commit 2dbebe5
Showing
10 changed files
with
265 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# 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, sex characteristics, 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 [[email protected]](mailto:[email protected]). 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](https://www.contributor-covenant.org), version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). | ||
|
||
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Contributing to WeatherMate App | ||
|
||
First and foremost, thank you for considering contributing to StickyNotes App! Your time and skills are valuable to us, and we appreciate any help you can provide to make this app better for everyone. Whether you're fixing a bug, adding a new feature, or improving the documentation, your contribution is essential. | ||
|
||
## Code of Conduct | ||
|
||
Our community is dedicated to providing a harassment-free experience for everyone. We do not tolerate harassment of community members in any form. Please refer to our Code of Conduct for complete details. | ||
|
||
## Getting Started | ||
|
||
Before you begin, please ensure you have a GitHub account and have familiarized yourself with the [GitHub flow](https://guides.github.com/introduction/flow/). This will involve creating a branch, making changes, submitting a pull request, and reviewing and discussing these changes. | ||
|
||
### Reporting Bugs | ||
|
||
Bugs are tracked as GitHub issues. To report a bug, please follow these guidelines: | ||
|
||
1. **Use the GitHub issue search** to check if the issue has already been reported. | ||
2. If the issue is unreported, **open a new issue**. Provide a **clear title and description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. | ||
|
||
### Suggesting Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion for StickyNotes App, including completely new features and minor improvements to existing functionality. | ||
|
||
1. **Use the GitHub issue search** to check if the enhancement has already been suggested. | ||
2. If it hasn't, **open a new issue**. Provide a **clear title and description**, as detailed as possible and if possible, include **examples** of how the enhancement would work. | ||
|
||
### Your First Code Contribution | ||
|
||
Unsure where to begin contributing to StickyNotes App? Look for the `good first issue` label in the issues section, which is a great start for newcomers. | ||
|
||
### Pull Requests | ||
|
||
1. **Fork** the repo and **create your branch** from `main`. | ||
2. **Make your changes** and ensure they meet the project standards. | ||
3. **Write or adapt tests** as needed. | ||
4. **Ensure your code lints** (if applicable). | ||
5. **Issue that pull request!** | ||
|
||
## Styleguides | ||
|
||
### Git Commit Messages | ||
|
||
- Use the present tense ("Add feature" not "Added feature"). | ||
- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). | ||
- Limit the first line to 72 characters or less. | ||
- Reference issues and pull requests liberally after the first line. | ||
|
||
### JavaScript Styleguide | ||
|
||
All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/). | ||
|
||
### CSS/HTML Styleguide | ||
|
||
- Use soft tabs with two spaces—they're the only way to guarantee code renders the same in any environment. | ||
- Use HTML5 doctype (`<!DOCTYPE html>`). | ||
- Avoid inline styles where possible. | ||
|
||
## Additional Notes | ||
|
||
### Issue and Pull Request Labels | ||
|
||
This section lists the labels we use to help us track and manage issues and pull requests. | ||
|
||
- **`good first issue`** – Good for newcomers. | ||
- **`bug`** – Something isn't working. | ||
- **`enhancement`** – New feature or request. | ||
- **`help wanted`** – Extra attention is needed. | ||
|
||
## Conclusion | ||
|
||
Contributions to StickyNotes App are greatly appreciated and vital for its continuous development. By participating in this project, you agree to abide by its terms. Thank you for your contributions – happy coding! | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# These are supported funding model platforms - auto generated by GitHub | ||
|
||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: # Replace with a single Ko-fi username | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry | ||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Pull Request for The WeatherMate | ||
|
||
## Overview | ||
Briefly describe the purpose of this pull request. What features or bug fixes are included? | ||
|
||
## Related Issue/Ticket | ||
Link any related issue or ticket here. | ||
|
||
## Files Changed | ||
List the files that have been added, deleted, or modified. | ||
|
||
## Testing | ||
Describe how you tested these changes. | ||
|
||
## Screenshots (if applicable) | ||
Include screenshots or GIFs if you've made UI changes. | ||
|
||
## Notes to Reviewers | ||
Add any notes for reviewers, such as areas to focus on, decisions you made, etc. | ||
|
||
## Deployment Notes | ||
Include any necessary steps for deployment, configuration changes, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
## Configuration for probot-stale - https://github.com/probot/stale | ||
# | ||
## Number of days of inactivity before an issue or pull request becomes stale | ||
#daysUntilStale: 60 | ||
# | ||
## Number of days of inactivity before a stale issue or pull request is closed | ||
#daysUntilClose: 7 | ||
# | ||
## Issues or pull requests with these labels will never be considered stale | ||
#exemptLabels: | ||
# - pinned | ||
# - security | ||
# - high-priority | ||
# | ||
## Label to use when marking an issue or pull request as stale | ||
#staleLabel: stale | ||
# | ||
## Comment to post when marking an issue or pull request as stale. Set to `false` to disable | ||
#markComment: > | ||
# Hi there! This issue has been inactive for a while. If the issue is still relevant, please comment on it or make the necessary updates. Otherwise, it will be closed in 7 days. | ||
# | ||
## Comment to post when closing a stale issue or pull request. Set to `false` to disable | ||
#closeComment: > | ||
# This issue has been closed due to inactivity. | ||
# | ||
## Limit the number of actions per hour to avoid hitting rate limits | ||
#limitPerRun: 30 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters