-
-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from LitZeus/docs-update
📄 Documentation Chaos: Added CONTRIBUTING.md & CODE_OFCONDUCT.md for Issue #12
- Loading branch information
Showing
2 changed files
with
111 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,29 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our community include: | ||
|
||
- Demonstrating empathy and kindness toward other people | ||
- Being respectful of differing opinions, viewpoints, and experiences | ||
- Giving and gracefully accepting constructive feedback | ||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
- Focusing on what is best not just for us as individuals, but for the overall community | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders. All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. |
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,82 @@ | ||
# Contributing to ChaosWeb | ||
|
||
🎉 **Welcome, brave developer!** 🎉 | ||
Thank you for your interest in contributing to **ChaosWeb**, the most chaotic UI/UX experiment on the internet. We believe that sometimes breaking the rules can lead to innovative and fun discoveries. Whether you're here to fix a bug, suggest a new feature, or add more chaos to the project, your contributions are highly appreciated! | ||
|
||
## 📝 How to Contribute | ||
|
||
### 1. Fork the Repository | ||
- Start by forking this repository to your GitHub account. | ||
- This creates your own copy of the project, where you can make and test changes. | ||
|
||
### 2. Clone the Repository | ||
- Clone the repository to your local machine for development. | ||
|
||
```bash | ||
git clone https://github.com/YourUsername/ChaosWeb.git | ||
``` | ||
|
||
### 3. Create a Branch | ||
- Create a new branch specific to the feature or fix you’re working on. Keep it organized by using descriptive names, such as: | ||
|
||
```bash | ||
git checkout -b feature-add-random-movement | ||
``` | ||
|
||
### 4. Commit Your Changes | ||
- Add and commit your changes with meaningful commit messages. | ||
|
||
```bash | ||
git add . | ||
git commit -m "Added random movement for elements" | ||
``` | ||
|
||
### 5. Push Your Branch | ||
- Push your branch to your forked repository. | ||
```bash | ||
git push origin feature-add-random-movement | ||
``` | ||
|
||
### 6. Open a Pull Request | ||
|
||
- Open a pull request from your branch into the `main` branch of this repository. | ||
- Be sure to explain what your changes do, why they're needed, and any potential issues they might cause. | ||
|
||
### 7. Wait for Review | ||
|
||
- One of the project maintainers will review your pull request and provide feedback or merge it if all looks good! | ||
|
||
## 🧪 Adding New Features | ||
|
||
### Want to make ChaosWeb even more chaotic? | ||
|
||
- Feel free to experiment with wild and unconventional ideas! | ||
- All ideas are welcome, but remember, **ChaosWeb’s goal is to confuse and entertain**, so your features should align with this purpose. | ||
|
||
|
||
Please create an issue before working on any major new feature so we can discuss it! | ||
|
||
## 🐛 Reporting Bugs | ||
|
||
Even chaos has bugs! If you find something that’s not working as intended (or too well-ordered for ChaosWeb standards): | ||
|
||
- Open an issue with a clear description of the problem. | ||
- Include steps to reproduce the bug, along with screenshots or other relevant info. | ||
|
||
## 🌟 Code Style Guide | ||
|
||
- **HTML/CSS**: Clean, well-indented, and readable. | ||
- **JavaScript**: Use `const` and `let` over `var`. Keep functions small and modular. | ||
- **Comments**: Comment any tricky or confusing code to help future contributors. | ||
|
||
## ⚠️ Code of Conduct | ||
|
||
**Please be kind and respectful when contributing. The goal is to learn, have fun, and create something truly chaotic together!** | ||
|
||
## 💡 Ideas for First Contributions | ||
|
||
If you’re new to the project, consider starting with one of these beginner-friendly tasks: | ||
|
||
- Fix typos or improve documentation. | ||
- Tweak the randomness of an element's behavior. | ||
- Add new unpredictable animations or UI elements. |