-
Notifications
You must be signed in to change notification settings - Fork 7
Added Contributing.md #20
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
Open
shubhranshu-sahu
wants to merge
1
commit into
thedevyashsaini:master
Choose a base branch
from
shubhranshu-sahu:contributing
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,114 @@ | ||
| # π€ Contributing Guidelines | ||
|
|
||
| Thank you for showing interest in contributing to **Rusticle**! π¦β¨ | ||
| We welcome contributions that make this interpreter more robust, user-friendly, and fun to use. | ||
|
|
||
| Whether you are fixing a bug, improving the interpreter, enhancing the documentation, or experimenting with new features, your contributions are highly valued! | ||
|
|
||
| --- | ||
|
|
||
| ## π How to Contribute | ||
|
|
||
| ### 1. Fork the repository | ||
| Click on the **Fork** button at the top-right of this repository. | ||
|
|
||
| ### 2. Clone your fork | ||
| Clone your forked repository to your local machine: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/<your-username>/rusticle.git | ||
| cd rusticle | ||
| ``` | ||
|
|
||
| ### 3. Add the upstream remote (one-time setup) | ||
| To keep your fork updated with the original repository: | ||
|
|
||
| ```bash | ||
| git remote add upstream https://github.com/thedevyashsaini/rusticle.git | ||
| ``` | ||
|
|
||
| ### 4. Create a new branch | ||
| Always create a new branch before making changes: | ||
|
|
||
| ```bash | ||
| git checkout -b feature-name | ||
| ``` | ||
|
|
||
| ### 5. Make your changes | ||
| - Follow the existing folder and module structure. | ||
| - Test your code changes using: | ||
|
|
||
| ```bash | ||
| cargo run --quiet -- example.lin | ||
| ``` | ||
|
|
||
| ### 6. Commit your changes | ||
| Use clear and meaningful commit messages: | ||
|
|
||
| ```bash | ||
| git add . | ||
| git commit -m "Add: description of your change" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. align the commit example with conventional commit format - like |
||
| ``` | ||
|
|
||
| ### 7. Keep your branch updated | ||
| Before pushing, sync with upstream: | ||
|
|
||
| ```bash | ||
| git fetch upstream | ||
| git rebase upstream/main | ||
| ``` | ||
|
|
||
| Resolve any conflicts if they appear. | ||
|
|
||
| ### 8. Push and Open a Pull Request | ||
| Push your branch: | ||
|
|
||
| ```bash | ||
| git push origin feature-name | ||
| ``` | ||
|
|
||
| Open a Pull Request (PR) from your fork to the **main** branch of the original repository. | ||
|
|
||
| --- | ||
|
|
||
| ## π‘ Where Can You Contribute? | ||
|
|
||
| - **Fix Bugs:** Resolve issues in the interpreter logic, CLI, or syntax handling. | ||
| - **Add Features:** Implement new language features or commands. | ||
| - **Improve Docs:** Make the README, Syntax guide, or Contributing guide better. | ||
| - **Refactor Code:** Clean up and optimize existing Rust code. | ||
| - **Testing:** Write additional tests to make the interpreter more stable. | ||
|
|
||
| --- | ||
|
|
||
| ## π§ͺ Development Tips | ||
|
|
||
| - Use `cargo run` frequently to test your changes. | ||
| - Write modular and well-documented Rust code. | ||
| - Check `Syntax.md` for how the language is structured. | ||
|
|
||
| --- | ||
|
|
||
| ## π Code of Conduct | ||
|
|
||
| By contributing to this repository, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md) to maintain a friendly and inclusive community. | ||
|
|
||
| --- | ||
|
|
||
| ## π€ Need Help? | ||
|
|
||
| - Open a **GitHub Issue** for bugs or feature suggestions. | ||
| - Join discussions or contact maintainers if you have doubts. | ||
|
|
||
| --- | ||
|
|
||
| ## π Quick Checklist for PRs | ||
|
|
||
| - [ ] Code tested and works locally | ||
| - [ ] Clear and descriptive commit message | ||
| - [ ] Documentation updated if required | ||
|
|
||
| --- | ||
|
|
||
| Thank you for contributing to **Rusticle**! | ||
| Letβs build something cool together! π | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
optional but useful - maybe suggest contributors run
cargo fmtandcargo clippybefore committing, helps keep code clean and consistent.