You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
First and foremost, a huge thank you for considering contributing to Chimera! Whether you're fixing a bug, proposing a new feature, or pondering becoming a maintainer, your support is what keeps this project alive and kicking. 🫶
4
+
5
+
## About 📄
2
6
3
7
We want to make contributing to this project as easy and transparent as possible, whether it's:
4
8
@@ -8,41 +12,50 @@ We want to make contributing to this project as easy and transparent as possible
8
12
- Proposing new features
9
13
- Becoming a maintainer
10
14
11
-
## We Develop with Github
15
+
Therefore we've created this document to provide a set of best practices for your contributions!
12
16
13
-
We use github to host code, to track issues and feature requests, as well as accept pull requests.
17
+
## How to Contribute
14
18
15
-
##SOON: We will Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
19
+
### Reporting a bug 🐛
16
20
17
-
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
21
+
**Spot a bug?** We use Github [issues](https://github.com/ChimeraCSS/ChimeraCSS/issues) for tracking. Reporting is simple:
18
22
19
-
1. Fork the repo and create your branch from `master`.
20
-
2. If you've added code that should be tested, add tests.
21
-
3. Ensure the test suite passes.
22
-
4. Make sure your code lints.
23
-
5. Issue that pull request!
23
+
1.**Check if the bug exists:** Browse existing issues to avoid duplicates
24
+
2.**Report:**[Open a new issue](https://github.com/ChimeraCSS/ChimeraCSS/issues/new/choose), providing a clear title and description. Screenshots and code snippets are highly encouraged!
24
25
25
-
##Any contributions you make will be under the Apache license 2.0
26
+
### Discuss the State of the Code 💬
26
27
27
-
In short, when you submit code changes, your submissions are understood to be under the same Apache license 2.0 license that covers the project. Feel free to contact the maintainers if that's a concern.
28
+
Engaging in discussions about the current state of the code, potential improvements, and innovative ideas are highly encouraged!
29
+
30
+
**Want to start a discussion?**[Create a new discussion](https://github.com/ChimeraCSS/ChimeraCSS/discussions/new/choose), choosing the category you want to discuss!
28
31
29
-
## Report bugs using Github's [issues](https://github.com/J0hans1/Chimera/issues)
32
+
Here's some of our **Best Practices for Discussion:**
30
33
31
-
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
34
+
-**Be Respectful:** Respect others' opinions and be open to feedback. We strive for a welcoming and inclusive environment.
35
+
-**Stay On Topic:** Keep discussions focused on the technical aspects and how changes can improve the project.
36
+
-**Provide Context:** When suggesting changes or highlighting issues, provide as much context as possible. Links to documentation, previous discussions, or examples can be incredibly helpful.
37
+
-**Ask Questions:** Don’t hesitate to ask for clarification if something isn’t clear. Our community is here to help each other.
32
38
33
-
##Use a Consistent Coding Style
39
+
### Code Contribution 🤝
34
40
35
-
- we use prettier formatting
41
+
Before you dive in, here are some key points to ensure your contributions make a smooth landing:
36
42
37
-
## License
43
+
-**Coding Style:** We use Prettier for formatting. Ensure your code align with our style guide for consistency.
44
+
-**SCSS over CSS:** Make your styling changes in `.scss` files, not `.css`. Remember to compile & build your SCSS changes with `sass sass/main.scss css/chimera.css`.
45
+
-**Pull Requests:** Ready to submit your code? Open a pull request with a clear list of what you've done. The more detailed, the better!
38
46
39
-
By contributing, you agree that your contributions will be licensed under its Apache License.
47
+
### Proposing Features 💡
40
48
41
-
## References
49
+
Got an idea for a new feature? We're all ears!! Here's how to propose it:
42
50
43
-
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
51
+
1.**Check Existing Discussions:** Browse through our [Discussion board](https://github.com/ChimeraCSS/ChimeraCSS/discussions) and [Issues](https://github.com/ChimeraCSS/ChimeraCSS/issues) to see if your idea has been previously suggested or discussed.
52
+
2.**Start with an Issue:**[Open a new issue](https://github.com/ChimeraCSS/ChimeraCSS/issues/new/choose) to discuss your idea. This allows for feedback and collaboration from the community.
53
+
3.**Outline the Feature:** Provide a detailed explanation of the feature and its benefits.
44
54
45
-
##NB! Remember!
55
+
### Becoming a Maintainer 🧑🔧
46
56
47
-
- Dont write the styling changes in the .css files, write them in .scss files
48
-
- Remember to run `sass sass/main.scss css/chimera.css` to build the changes in sass/
57
+
Interested in taking a more active role in Chimera? Maintainers are crucial to our project's health and growth. Reach out to us with your contributions and interest!
58
+
59
+
## Any contributions you make will be under the Apache license 2.0
60
+
61
+
In short, when you submit code changes, your submissions are understood to be under the same Apache license 2.0 license that covers the project. Feel free to contact the maintainers if that's a concern.
0 commit comments