Skip to content

Commit 571132e

Browse files
committed
add CONTRIBUTING.md
1 parent af67092 commit 571132e

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to Argon
2+
We are excited that you are interested in contributing, Argon is a constantly evolving programming language and your contribution is essential to its success.
3+
4+
## Opening new issue
5+
Feel free to open a new issue in the following cases:
6+
7+
- Reporting bugs: If you encounter a bug, open an issue to report it, ensuring to include a detailed description of the problem, steps to reproduce it, and the environment you are working on (also, remember to specify the version of Argon you are using).
8+
9+
- Suggesting improvements: If you wish to suggest an improvement, you can open a new issue, ensuring your proposal includes a detailed description of the changes you intend to make and the rationale behind why you believe it is an improvement.
10+
11+
### Got a bright idea for Argon? We'd love to hear it!
12+
13+
Just open a new issue and share your thoughts. It's the same process as 'suggesting improvements' (see above). If the community loves it and you're feeling adventurous, you can even take charge!
14+
15+
1) Fork the project.
16+
2) Code your awesome idea into reality.
17+
3) Send us a pull request. We'll review it, and if everyone's happy, we'll merge it into the main project.
18+
19+
This way, you get to see your idea come to life and help shape the future of Argon!
20+
21+
## Pull request
22+
23+
- Fork this repository and create a new branch.
24+
- Add your code changes.
25+
- Add tests if relevant.
26+
- Change / add documentation as needed if any API changed.
27+
28+
When you're done, submit your pull request!
29+
30+
**Note:** Pull requests that make purely cosmetic changes (such as whitespace, indentation, etc.) will not be considered.
31+

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,15 @@ Argon is under active development, so many features are not yet active or availa
114114
* Currently, all test cases are disabled ~~and out of date~~.
115115

116116
# 🤝 Contributing
117-
There is currently no guide available to contribute to the development, but if you are interested you can contribute in several ways:
118-
* Argon core (C++)
119-
* Argon builtins libraries (C++ / Argon)
120-
* Writing documentation
117+
If you're interested, there are several ways you can contribute:
118+
119+
- **Argon Core**: Help develop the Argon core (C++).
120+
- **Improving the Argon Standard Library**: Enhance the functionality of the [Argon Standard Library](https://github.com/argonlang/arlib).
121+
- **Writing/Improving Documentation**: Contribute by writing or improving documentation.
122+
- **Writing Examples**: Create examples to demonstrate Argon's capabilities.
123+
- **Sharing and Promotion**: Spread the word about the project and make it more widely known.
124+
125+
For technical details, refer to the [contributing guidelines](CONTRIBUTING.md).
121126

122127
# License
123128
Argon is primarily distributed under the terms of the Apache License (Version 2.0).

0 commit comments

Comments
 (0)