File: CONTRIBUTING.md

package info (click to toggle)
lfortran 0.58.0-3
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 54,508 kB
  • sloc: cpp: 162,179; f90: 68,251; python: 17,476; ansic: 6,278; yacc: 2,334; sh: 1,317; fortran: 892; makefile: 34; javascript: 15
file content (59 lines) | stat: -rw-r--r-- 1,899 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
## Contributing

We welcome contributions from anyone, even if you are new to open source. It
might sound daunting to contribute to a compiler at first, but please do, it is
not complicated. We will help you with any technical issues and help improve
your contribution so that it can be merged.

### Getting Started

To contribute, follow these steps:

1. **Fork the Repository**

    Fork the [LFortran repository](https://github.com/lfortran/lfortran) to 
    your GitHub account.

2. **Clone Your Fork**

   Clone your forked repository to your local machine:
   ```
   git clone https://github.com/<your-username>/lfortran.git
   cd lfortran
   ```

3. **Add the Upstream Repository**

    Add the original LFortran repository as the upstream remote.
    ```
    git remote add upstream https://github.com/lfortran/lfortran.git
    git fetch upstream --tags
    ```

4. **Install Dependencies and Build the Project**

    Follow the [installation guide](https://docs.lfortran.org/en/installation/#build-from-git) 
    to set up the required dependencies and build the project.

5. **Make Changes and Submit Your Contribution**

    Create a branch for your changes and make the necessary edits.
    When ready, push your changes to your fork and submit a Pull Request (PR) 
    against our repository at: https://github.com/lfortran/lfortran.

### Communication

If you have any questions or need help, please ask as at our
[mailinglist](https://groups.io/g/lfortran) or a
[chat](https://lfortran.zulipchat.com/).

### Code of Conduct

Please note that all participants of this project are expected to follow our
Code of Conduct. By participating in this project you agree to abide by its
terms. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

### Licensing

By submitting a PR you agree to license your contribution under
the LFortran's BSD [license](LICENSE) unless explicitly noted otherwise.